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

update(packaging): make changelog compliant with 'keep a changelog' convention #106

Merged

Conversation

Guts
Copy link
Collaborator

@Guts Guts commented Nov 6, 2024

This PR cleans up the changelog to make it compliant with the https://keepachangelog.com/fr/1.1.0/ convention which is used behind the scenes by a lot of tools and especially QGIS Plugin CI, which was added to this repository back in 2021 (#47).

Here are the main advantages:

  • document changes in a conventional file (CHANGELOG.md) instead of changelog section of metadata.txt
  • when using QGIS Plugin CI with package or release commands, it will load the CHANGELOG.md content to extract the latest version number (or the one specified), the associated changes and write them into the metadata.txt
  • Github understands and features the CHANGELOG.md
  • it can be added to the online doc

@xcaeag xcaeag merged commit 36ec0e1 into aeag:master Nov 7, 2024
@Guts Guts deleted the packaging/make-changelog-compliant-with-convention branch November 7, 2024 11:59
@Guts Guts added the packaging label Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants