Changelog (CLI)#
Manipulate CHANGELOG.md
file, extracting relevant information.
Used within the package and release commands to populate the metadata.txt
and the GitHub Release description.
By default, the script will look for a file CHANGELOG.md
in the root folder.
But you can specify a specific file path with changelog_path
in the configuration file.
For instance:
changelog_path=CHANGELOG-3.4.md
or
changelog_path=subfolder/CHANGELOG.md
Command help#
usage: qgis-plugin-ci changelog [-h] release_version
positional arguments:
release_version The version to be released. If nothing is speficied, the latest
version specified into the changelog is used.
optional arguments:
-h, --help show this help message and exit
Requirements#
The CHANGELOG.md
file must follow the convention Keep A Changelog. For example, see this repository changelog.
Use cases#
Extract the
CHANGELOG.md
content and copy it into thechangelog
section within pluginmetadata.txt
Extract the
n
latest versions fromCHANGELOG.md
intometadata.txt
Get the latest version release note
Examples#
Extract changelog for latest version#
$ qgis-plugin-ci changelog latest
- Separate python files and UI files in the temporary PRO file (#29)