Add-on for zest.releaser for releasing QGIS plugins.
Zest.releaser can be extended, see its entrypoints documentation.
What we do:
We hook into the “release” step and create a zipfile with a version number and copy it to the current directory. You can scp it to a server afterwards.
In the “prerelease” and “postrelease” steps we change the version number in the (mandatory) QGIS metadata.txt file.
Note: a QGIS plugin doesn’t have a setup.py, so you’ll need to add a version.txt or version.rst or VERSION file so that zest.releaser recognizes the current directory as a releasable project and so that it can find the version number somewhere. Simply put the version number (“1.2”) by itself on the first line. A newline at the end is fine.
Installation
You’ll have to install it globally (or in a custom virtualenv) as qgis plugins normally don’t have a full python setup.
The plugin checks whether there’s a metadata.txt (lowercase) with a qgisMinimumVersion string inside it. If found, the plugin runs. Otherwise it stays out of the way. So it should be safe to install globally.
Development of the plugin
Use uv for installing the project in development. Some commands:
$ uv run pytest $ pre-commit run --all
Release files for qgispluginreleaser 2.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| qgispluginreleaser-2.0.2.tar.gz | 15.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| qgispluginreleaser-2.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 32.4 kB
Release files / qgispluginreleaser-2.0.2.tar.gz
| Download URL | qgispluginreleaser-2.0.2.tar.gz |
|---|---|
| Size | 15.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5f165b432751ff0ee866fff297c9b77b5214a2c86cb40f6041dec60fa2b36c12
|
|
BLAKE2b-256 checksum How to use checksums |
d89a62387cac0eecc5c8d8087a28299cc7e199f132250d5920a23165a31164a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.3
|
Release files / qgispluginreleaser-2.0.2-py3-none-any.whl
| Download URL | qgispluginreleaser-2.0.2-py3-none-any.whl |
|---|---|
| Size | 16.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9c3af13c6596fda7eaf5a661439c3670e7c1b487bc5b061148787252e3634fbc
|
|
BLAKE2b-256 checksum How to use checksums |
195041f558a84af7d97a003af0f5ba47419cdac37a5441f71ca80a1b2fc68654
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.3
|
