Changelog Workflows

Introduction

blah blah

General Workflow

1. The changelog maintainer (currently GitHub user: zacharlie) is added to the ‘Community’ GitHub group which has triage rights

2. The changelog maintainer will read each Pull Request (PR) that has a Feature label as it comes in as per the following URL:

https://github.com/qgis/QGIS/pulls?q=is%3Aopen+is%3Apr+label%3AFeature

In the comments section, they will make a comment to the author if the feature is not clear / well described. We would be grateful if the PR gatekeepers could hold back on merging Feature PR’s that have issues, do not have a Changelog tag applied. Once the Changelog tag has been added, the PR maintainers should feel free to merge the PR if they are happy with it.

Note that the English doesn’t need to be perfect (we are understanding that English may not be your mother tongue), the important thing is that the functionality is well described - we will tidy up the English in step 6 below.

3. Once the PR description is good, the changelog maintainer will add the ‘Changelog’ tag to it as per the example below.

4. Once the PR is merged, we will regularly Harvest the ‘Changelog tagged entries to the Changelog site. This is done using the ingestion tool as shown in the screenshot below:

5. After the closed Changelog PRs have been harvested, we will go here:

https://github.com/qgis/QGIS/pulls?q=is%3Apr+is%3Aclosed+label%3AChangelog

First we will apply the additional tag on GitHub called ‘ChangelogHarvested’. Next remove the Changelog tag.

This will prevent the same PR being reharvested in subsequent harvest runs on the changelog platform.

6. The entry will then be tidied up on the changelog site ready for the release. Additional volunteers from the changelog maintainers team will help improve the clarity and consistency of the entries on the changelog site. The entry should follow the contensions that are described in the "Conventions for changelog entries" section below.

7. When the release comes near we need the paid bug fixing entries added under 'Notable fixes'. This is managed by Andreas Neumann.

8. After the changelog is finalised, notify Richard who will then pull the changelog to the QGIS web site.

More on tagging

We will add the tag when we want to ingest it so we will have 3 states basically:

1. Feature tag - not ready for ingestion in Changelog
2. Feature tag + Changelog tag + PR Merged - ready for ingestion
3. Feature tag + ChangelogHarvested tag + PR merged - entry has been ingested

Conventions for changelog entries