evergreen-docs:release_notes_process
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
evergreen-docs:release_notes_process [2017/10/19 10:20] – [Major Release Notes] sandbergja | evergreen-docs:release_notes_process [2024/02/12 15:55] (current) – Release notes from commits stub stompro | ||
---|---|---|---|
Line 1: | Line 1: | ||
=====Release Notes Process for DIG Release Coordinator===== | =====Release Notes Process for DIG Release Coordinator===== | ||
+ | |||
====Major Release Notes==== | ====Major Release Notes==== | ||
+ | |||
+ | => See also the [[dev: | ||
===Preparing for the release=== | ===Preparing for the release=== | ||
- | Before the beta is cut, periodically review [[https:// | + | Before the beta is cut, periodically review [[https:// |
===Generating the release notes file=== | ===Generating the release notes file=== | ||
- Developers and others add release notes to the docs/ | - Developers and others add release notes to the docs/ | ||
- Around the time the beta is released, the create_release_notes.sh script is run, which generates a new Release Notes file containing all the notes contained in RELEASE_NOTES_NEXT. | - Around the time the beta is released, the create_release_notes.sh script is run, which generates a new Release Notes file containing all the notes contained in RELEASE_NOTES_NEXT. | ||
+ | - Remove the individual files from RELEASE_NOTES_NEXT after they are compiled, as otherwise things can get mixed up. | ||
- After this script is run, make all copyediting, | - After this script is run, make all copyediting, | ||
- | ====Point Release Notes==== | ||
- | ====Acknowledgements==== | + | ==(Fixme: Proposed Enhancement)Extract Release Notes From Commits script== |
+ | - Use the docs/ | ||
+ | - Release notes for bug fixes that use the *Release-note: | ||
+ | - Contributors List (Author, Committers, Reviewers). | ||
+ | - Sponsors (grabbing the sponsored-by: | ||
+ | - See [[https:// | ||
+ | - Enhance these instructions once the script has been used. | ||
+ | ===Acknowledgements for Major Releases=== | ||
- | The acknowledgements section is an opportunity to thank everyone who has contribute to a particular release. In major release notes, we include acknowledgements for contributors, | + | The acknowledgements section is an opportunity to thank everyone who has contribute to a particular release. In major release notes, we include acknowledgements for contributors, |
- | ===Acknowledgements for Major Releases=== | ||
* For **organizations that commissioned development**, | * For **organizations that commissioned development**, | ||
* For **individuals who contributed code, management, translations, | * For **individuals who contributed code, management, translations, | ||
* Acknowledge the code contributors who authored any portion of the **new features** that are listed in the release notes. By focusing on new features, we are omitting many code contributions made to that particular branch that were bug fixes. The reason for this omission is that, since those branches were backported, those contributors were already acknowledged in the monthly point release notes for other releases. | * Acknowledge the code contributors who authored any portion of the **new features** that are listed in the release notes. By focusing on new features, we are omitting many code contributions made to that particular branch that were bug fixes. The reason for this omission is that, since those branches were backported, those contributors were already acknowledged in the monthly point release notes for other releases. | ||
+ | * One workflow to get this information: | ||
+ | * Use the list of new features to identify the Launchpad bug IDs. A good way to find those bugs in launchpad without much searching is to look on the [[https:// | ||
+ | * For each launchpad bug ID, search the commit messages for this ID. | ||
+ | * Note the people who authored and signed off on each relevant commit. | ||
* Acknowledge contributors responsible for managing or building the release. | * Acknowledge contributors responsible for managing or building the release. | ||
* Acknowledge translators who added translations for one of the ' | * Acknowledge translators who added translations for one of the ' | ||
* Acknowledge documenters who have contributed documentations for new features in this release. As is the case with code contributors, | * Acknowledge documenters who have contributed documentations for new features in this release. As is the case with code contributors, | ||
- | * Acknowledge authors of any tests that were written for that release. Tests are most often written with the code for a new feature or a bug fix. However, when a test is written apart from any new feature or bug fix, those tests are typically merged to the master | + | * Acknowledge authors of any tests that were written for that release. Tests are most often written with the code for a new feature or a bug fix. However, when a test is written apart from any new feature or bug fix, those tests are typically merged to the main branch and not backported. Therefore, those authors should be acknowledged in the major release notes. |
- | * For **organizations whose employees contributed patches**, identify the library institutions, | + | * For **organizations whose employees contributed patches**, identify the library institutions, |
+ | |||
+ | |||
+ | ====Point Release Notes==== | ||
+ | |||
+ | ==List of bug fixes== | ||
+ | - Go through the git commits for each release branch (e.g. rel_17_9 and rel_17_10) to find which bugs have been fixed since the last release. It's easier to start with the earliest branch (e.g. rel_17_9). | ||
+ | - Add a complete list of bug fixes to the top of the appropriate release notes file (e.g. RELEASE_NOTES_17_9.adoc) using Asciidoc. | ||
+ | - Commit your changes with a commit message like "Docs: Release notes for Evergreen 17.9.3" | ||
+ | - Repeat the process for each other relevant release. | ||
+ | - Push the commits to the release notes to the following branches: | ||
+ | * main | ||
+ | * the newer major release branch (e.g. rel_17_10) | ||
+ | * the older major release branch, but only include the changes to the earlier branch (e.g. don't put the 17.10 changes in the rel_17_9 branch). | ||
+ | * if point release branches have been created, cherry-pick to them as well. | ||
+ | |||
+ | ==Acknowledgements for Point Releases== | ||
+ | Acknowledgements for point release notes have varied, but current practice has been to acknowledge the contributors, | ||
+ | |||
+ | * Provide an acknowledgement for each of the authors of the code commits that were merged to that release branch. Also include people who signed off on commits. | ||
+ | * You could use git to find all the authors/ | ||
+ | * '' | ||
+ | * If you want to limit it to authors and committers, try the following: | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
- | ===Acknowledgements for Point Releases=== | ||
- | * Provide an acknowledgement for each of the authors of the code commits that were merged to that release branch. |
evergreen-docs/release_notes_process.1508422812.txt.gz · Last modified: 2022/02/10 13:34 (external edit)