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 revisionPrevious revision
Next revision
Previous revision
evergreen-docs:release_notes_process [2018/09/07 11:26] – add see also sandbergjaevergreen-docs:release_notes_process [2024/02/12 15:55] (current) – Release notes from commits stub stompro
Line 4: Line 4:
 ====Major Release Notes==== ====Major Release Notes====
  
-=> See also the [[dev:release_process:evergreen:2.8#prepare_release_notes_for_major_version_bumps_only|release notes section of the release process page]]+=> See also the [[dev:release_process:evergreen:how_to_build#prepare_release_notes_for_major_version_bumps_only|release notes section of the release process page]]
  
 ===Preparing for the release=== ===Preparing for the release===
  
-Before the beta is cut, periodically review [[https://bugs.launchpad.net/evergreen/+bugs?field.tag=pullrequest|Launchpad Wishlist bugs with a pullrequest tag]] to see if they have the necessary release notes. If they don't, add the needsreleasenotes tag to them. If the person submitting the bug is fairly new, guide them through the process, using [[https://wiki.evergreen-ils.org/doku.php?id=contributing:release_notes|these release notes guidelines]] as a reference.+Before the beta is cut, periodically review [[https://bugs.launchpad.net/evergreen/+bugs?field.tag=pullrequest|Launchpad Wishlist bugs with a pullrequest tag]] to see if they have the necessary release notes. If they don't, add the ''needsreleasenotes'' tag to them. If the person submitting the bug is fairly new, guide them through the process, using [[https://wiki.evergreen-ils.org/doku.php?id=contributing:release_notes|these release notes guidelines]] as a reference.
  
 ===Generating the release notes file=== ===Generating the release notes file===
Line 16: Line 16:
   - After this script is run, make all copyediting, acknowledgment, and other changes to the file produced by create_release_notes.sh.  Don't run this script again; you will lose your work!   - After this script is run, make all copyediting, acknowledgment, and other changes to the file produced by create_release_notes.sh.  Don't run this script again; you will lose your work!
  
 +==(Fixme: Proposed Enhancement)Extract Release Notes From Commits script==
 +  - Use the docs/tools/extract_release_notes_from_commits.pl script to extract the following from commits.
 +    - Release notes for bug fixes that use the *Release-note:* commit tag.
 +    - Contributors List (Author, Committers, Reviewers).
 +    - Sponsors (grabbing the sponsored-by: tag)
 +  - See [[https://bugs.launchpad.net/evergreen/+bug/2051874|Bug #2051874]] for details.
 +  - Enhance these instructions once the script has been used.
 ===Acknowledgements for Major Releases=== ===Acknowledgements for Major Releases===
  
Line 30: Line 37:
     * Acknowledge translators who added translations for one of the 'official' Evergreen languages since the cutting of the last major release. These translators can be identified by going to [[https://translations.launchpad.net/evergreen]], sorting the languages by 'Last Changed' date, and then clicking into each of the languages that have been changed since the last release. Within each language, the last edit date will be listed for each of the templates along with the translator who made the last edit.     * Acknowledge translators who added translations for one of the 'official' Evergreen languages since the cutting of the last major release. These translators can be identified by going to [[https://translations.launchpad.net/evergreen]], sorting the languages by 'Last Changed' date, and then clicking into each of the languages that have been changed since the last release. Within each language, the last edit date will be listed for each of the templates along with the translator who made the last edit.
     * Acknowledge documenters who have contributed documentations for new features in this release. As is the case with code contributors, we are omitting some documentation contributions made to that particular branch because they were backported and acknowledged at the time of the point release.     * Acknowledge documenters who have contributed documentations for new features in this release. As is the case with code contributors, we are omitting some documentation contributions made to that particular branch because they were backported and acknowledged at the time of the point release.
-    * 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 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, companies, etc. who employee the contributors acknowledged in the above section. In some cases, a code contributor may work for a library institution, but also do third-party contract work. Checking with those contributors is a good idea to ensure the appropriate organization is listed here.+  * For **organizations whose employees contributed patches**, identify the library institutions, companies, etc. who employ the contributors acknowledged in the above section. In some cases, a code contributor may work for a library institution, but also do third-party contract work. Checking with those contributors is a good idea to ensure the appropriate organization is listed here.
  
  
Line 38: Line 45:
 ==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.  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:
-    * master+    * main
     * the newer major release branch (e.g. rel_17_10)     * 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).     * 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).
Line 50: Line 57:
 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/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%%'' 
 +    * If you want to limit it to authors and committers, try the following: 
 +      * ''%%git log COMMIT_HASH^.. --format="%aN" | sort | uniq%%'' 
 +      * ''%%git log COMMIT_HASH^.. --format="%cN" | sort | uniq%%'' 
 +      * ''%aN'' is Author Name, and ''%cN'' is Committer Name 
evergreen-docs/release_notes_process.1536333991.txt.gz · Last modified: 2022/02/10 13:34 (external edit)

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

© 2008-2022 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a U.S. 501(c)3 non-profit organization.