sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-06-27 00:02:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated Changelog Workflows (markdown)

Charlie 2022-05-28 14:56:08 +02:00
parent ab08b6ec10
commit e4f0ebb4a6
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Changelog-Workflows.md

@ -23,7 +23,7 @@ Click the image above to play a YouTube video containing a walk-through by Charl
https://github.com/qgis/QGIS/pulls?q=isopen+is%3Apr+label%3AChangelog https://github.com/qgis/QGIS/pulls?q=isopen+is%3Apr+label%3AChangelog
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. 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.
3) Once the changelog maintainers are confident that the feature functionality is described well enough that a changelog entry of the expected quality standard may be produced, they will apply the **Changelog** label to the PR as per the following example. 3) Once the changelog maintainers are confident that the feature functionality is described well enough that a changelog entry of the expected quality standard may be produced, they will apply the **Changelog** label to the PR as per the following example.
@ -31,17 +31,19 @@ Click the image above to play a YouTube video containing a walk-through by Charl
After the **Changelog** tag has been added, the PR maintainers should feel free to merge the PR if they are happy with it. After 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 description doesn’t need to be perfect (it is understood that English may not be the mother tongue of many developers submitting features), however it is important that the functionality is well described. The English description will be edited for publication in step 6 below. > Note that the English description doesn't need to be perfect (it is understood that English may not be the mother tongue of many developers submitting features), however it is important that the functionality is well described. The English description will be edited for publication in step 6 below.
4) **Changelog** tagged entries which have been merged will be harvested to the Changelog site regularly. This is done using the ingestion tool as shown in the screenshot below: 4) **Changelog** tagged entries which have been merged will be harvested to the Changelog site regularly. This is done using the ingestion tool as shown in the screenshot below:
![image](https://user-images.githubusercontent.com/178003/87295427-0fdaf800-c4fd-11ea-9d8e-a30dce3f9fcd.png) ![image](https://user-images.githubusercontent.com/178003/87295427-0fdaf800-c4fd-11ea-9d8e-a30dce3f9fcd.png)
The ingestion tool harvest all closed PRs tagged with the changelog label. In some instances, PRs that may affect the changelog may not be merged, having been closed or considered stale. In such instances, the 'ChangelogExclude' label will be added so that these contributions will not be included in the harvesting process, but may be monitored and retagged with the 'Changelog' label in the future if the status of the pull request is changed.
5) After closed Changelog PRs have been harvested, we will list the harvested entries on GitHub via the following URL: 5) After closed Changelog PRs have been harvested, we will list the harvested entries on GitHub via the following URL:
https://github.com/qgis/QGIS/pulls?q=is%3Apr+is%3Aclosed+label%3AChangelog https://github.com/qgis/QGIS/pulls?q=is%3Apr+is%3Aclosed+label%3AChangelog
First, the additional label on GitHub called ‘ChangelogHarvested’ will be applied to indicate that the entry has been harvested into the changelog content management site. First, the additional label on GitHub called 'ChangelogHarvested' will be applied to indicate that the entry has been harvested into the changelog content management site.
Next, the **Changelog** label will be removed. This will prevent the same PR being reharvested (by the tool outlined in step 4) in subsequent harvest runs on the changelog platform, whilst retaining the relevant label required to indicate the PR contains a changelog entry. Next, the **Changelog** label will be removed. This will prevent the same PR being reharvested (by the tool outlined in step 4) in subsequent harvest runs on the changelog platform, whilst retaining the relevant label required to indicate the PR contains a changelog entry.
@ -49,14 +51,15 @@ Click the image above to play a YouTube video containing a walk-through by Charl
![image](https://user-images.githubusercontent.com/178003/87296792-3437d400-c4ff-11ea-8754-1017e2397612.png) ![image](https://user-images.githubusercontent.com/178003/87296792-3437d400-c4ff-11ea-8754-1017e2397612.png)
7) Prior to release, the Excluded Changelog entries that have not been harvested may be checked using the [available GitHub filters](https://github.com/qgis/QGIS/pulls?q=is%3Apr+is%3Aclosed+label%3AChangelogExclude) to ensure that any previously excluded functionality that has been added is included in the changelog prior to release.
7) Entries may be reviewed and edited from within the *General* section, but should only be assigned to a category once the content is publication-ready in order to easily segregate the records which have or have not undergone some form of review. 8) Entries may be reviewed and edited from within the *General* section, but should only be assigned to a category once the content is publication-ready in order to easily segregate the records which have or have not undergone some form of review.
8) When the release comes near, the paid bug fixing entries added under 'Notable fixes' will need to be added. This is managed by Andreas Neumann. 9) When the release comes near, the paid bug fixing entries added under 'Notable fixes' will need to be added. This is managed by Andreas Neumann.
![image](https://user-images.githubusercontent.com/178003/87296304-76ace100-c4fe-11ea-8eae-d73a59471e05.png) ![image](https://user-images.githubusercontent.com/178003/87296304-76ace100-c4fe-11ea-8eae-d73a59471e05.png)
9) After the changelog is finalised, changelog maintainers will notify Richard, who will then pull the changelog to the QGIS web site. 10) After the changelog is finalised, changelog maintainers will notify Richard, who will then pull the changelog to the QGIS web site.
## More on tagging ## More on tagging