User Tools

Site Tools


evergreen-docs:release_notes_process

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
evergreen-docs:release_notes_process [2019/05/17 10:41]
rjs7 [Point Release Notes]
evergreen-docs:release_notes_process [2019/08/19 19:04] (current)
sandbergja [Point Release Notes]
Line 38: 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_17_9.adoc) using Asciidoc. ​ You may be able to use the commit messages to describe most of the bug fixes. ​ You may also get some information from Launchpad. +  - 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. ​ You may be able to use the commit messages to describe most of the bug fixes. ​ You may also get some information from Launchpad.  For each entry in the list, include a link to the launchpad bug so that readers can easily find more information about the bug
-  - Commit your changes with a commit message like "Docs: Release notes for Evergreen 17.9.3"​. ​ This is [[http://​git.evergreen-ils.org/?​p=Evergreen.git;​a=blobdiff;​f=docs/​RELEASE_NOTES_2_12.adoc;h=cef385a5c6a099b9390108011e0167684f078d78;hp=469775dc1bed13da27f1d980423f75edf4a05a27;hb=ef37ec48d22bd0ac3e7d1f2b0b7fa118f56248eb;hpb=44a4403bfbfa6f4e5f44cdb9333558d27b1e2f0f|a typical point release note commit]].+  - Commit your changes with a commit message like "Docs: Release notes for Evergreen 17.9.3"​. ​ This is [[https://​git.evergreen-ils.org/?​p=Evergreen.git;​a=blobdiff;​f=docs/​RELEASE_NOTES_3_2.adoc;h=ef1cbc69a65866007713aa23e12007c563002cf1;hp=a184702fe51deea8504fb4540ab26682c459fcfb;hb=8d7eeb8720a6cacbf59c83e3bdd056c38b954d7b;hpb=b7f4592b7e032242d0209623f49d58cfca58c8c8|a typical point release note commit]].
   - Repeat the process for each other relevant release. ​ Much of this can be copy/​pasted,​ but there may also be fixes that weren'​t backported to some of those earlier releases.   - Repeat the process for each other relevant release. ​ Much of this can be copy/​pasted,​ but there may also be fixes that weren'​t backported to some of those earlier releases.
   - Push the commits to the release notes to the following branches:   - Push the commits to the release notes to the following branches:
Line 50: Line 50:
 Acknowledgements for point release notes have varied, but current practice has been to acknowledge the contributors,​ and not the employing organizations or organizations that sponsored development. Acknowledgements for point release notes have varied, but current practice has been to acknowledge the contributors,​ and not the employing organizations or organizations that sponsored development.
  
-  * Provide an acknowledgement for each of the authors of the code commits that were merged to that release branch.  +  * 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/​committers,​ if you know the commit hash for the last commit in the previous point release. ​ If you want to include everyone who signed off on commits, this command should get you close:+    * You could use git to find all the authors/​sign-offers/​committers,​ if you know the commit hash for the last commit in the previous point release. ​ If you want to include everyone who signed off on commits, this command should get you close:
       * ''​%%git log COMMIT_HASH^.. | grep "​Signed-off-by"​ | sort | uniq%%''​       * ''​%%git log COMMIT_HASH^.. | grep "​Signed-off-by"​ | sort | uniq%%''​
     * If you want to limit it to authors and committers, try the following:     * If you want to limit it to authors and committers, try the following:
evergreen-docs/release_notes_process.1558104094.txt.gz · Last modified: 2019/05/17 10:41 by rjs7

© 2008-2017 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a member of Software Freedom Conservancy.