Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Requirement for LICENSE file when updating plugin is not documented #9192

Closed
burkmarr opened this issue Aug 1, 2024 · 2 comments · Fixed by #9303
Closed

Requirement for LICENSE file when updating plugin is not documented #9192

burkmarr opened this issue Aug 1, 2024 · 2 comments · Fixed by #9303

Comments

@burkmarr
Copy link

burkmarr commented Aug 1, 2024

It appears that there is a new requirement when updating a plugin that it must contain a license file with the name LICENSE with no file extension. It is not clear from the error message that a license filed called, for example license.txt, will not suffice. This is not documented in https://docs.qgis.org/testing/en/docs/pyqgis_developer_cookbook/plugins/plugins.html. This problem has also been reported recently on Stackexchange (https://gis.stackexchange.com/questions/484049/cannot-find-license-in-the-plugin-package-error-when-updating-qgis-plugin/).

Page URL: https://docs.qgis.org/testing/en/docs/pyqgis_developer_cookbook/plugins/plugins.html

@ioalexei
Copy link
Contributor

Submitted a fix with #9303

Since this comment relates to uploading/updating a plugin in the QGIS plugins directory, I have added the clarification to 16.4 Releasing your plugin, under 16.4.3.4 Plugin structure

@DelazJ
Copy link
Collaborator

DelazJ commented Oct 14, 2024

Indeed it is about uploading to our plugins repo, but IMHO it could be nice to advise people earlier, at the beginning, to add a license file, along with other elements mentioned at https://docs.qgis.org/3.34/en/docs/pyqgis_developer_cookbook/plugins/plugins.html#set-up-plugin-file-structure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants