Packaging and deployment¶
Packaging¶
This plugin is using the qgis-plugin-ci tool to perform packaging operations.
Under the hood, the package command is performing a git archive
run based on CHANGELOG.md
.
Install additional dependencies:
python -m pip install -U -r requirements/packaging.txt
Then use it:
# package a specific version
qgis-plugin-ci package 1.3.1
# package latest version
qgis-plugin-ci package latest
Release a version¶
Through git workflow:
Add the new version to the
CHANGELOG.md
. You can write it manually or use the auto-generated release notes by Github:Go to project’s releases and click on
Draft a new release
In
Choose a tag
, enter the new tagClick on
Generate release notes
Copy/paste the generated text from
## What's changed
until the line before**Full changelog**:...
in the CHANGELOG.md replacingWhat's changed
with the tag and the publication dateQuit this tab without saving
Change the version number in
metadata.txt
with the next version andDEV
suffix. Example : if you’re about to release the version2.2.0
, the next one will be2.2.1-DEV
Commit the changelog modification to main branch:
git commit -m "release: bump version to 2.2.0"
Apply a git tag with the relevant version:
git tag -a 2.2.0 {git commit hash} -m "This version rocks!"
Push tag to main branch:
git push origin 2.2.0