evergreen-docs:release_notes_process
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
evergreen-docs:release_notes_process [2018/09/06 15:35] – [Major Release Notes] making the process a little clearer sandbergja | evergreen-docs:release_notes_process [2022/02/10 13:34] – external edit 127.0.0.1 | ||
---|---|---|---|
Line 3: | Line 3: | ||
====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=== | ||
Line 29: | Line 31: | ||
* 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 branch and not backported. Therefore, those authors should be acknowledged in the major release notes. | * 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 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, |
Line 36: | Line 38: | ||
==List of bug fixes== | ==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). | - 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_7_9.adoc) using Asciidoc. | + | - 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" | + | - Commit your changes with a commit message like "Docs: Release notes for Evergreen 17.9.3" |
- Repeat the process for each other relevant release. | - Repeat the process for each other relevant release. | ||
- Push the commits to the release notes to the following branches: | - Push the commits to the release notes to the following branches: | ||
Line 48: | Line 50: | ||
Acknowledgements for point release notes have varied, but current practice has been to acknowledge the contributors, | Acknowledgements for point release notes have varied, but current practice has been to acknowledge the contributors, | ||
- | | + | |
+ | * You could use git to find all the authors/ | ||
+ | * '' | ||
+ | * If you want to limit it to authors and committers, try the following: | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' |
evergreen-docs/release_notes_process.txt · Last modified: 2024/02/12 15:55 by stompro