User Tools

Site Tools


evergreen-docs:release_notes_process

This is an old revision of the document!


Release Notes Process for DIG Release Coordinator

Acknowledgements

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, their employing organizations, and the organizations that sponsored development in major release notes. 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.

Major Release Notes

Preparing for the release

Before the beta is cut, periodically review 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 these release notes guidelines as a reference.

Generating the release notes file

  1. Developers and others add release notes to the docs/RELEASE_NOTES_NEXT directory.
  2. 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.
  3. 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!

Acknowledgements for Major Releases

  • For organizations that commissioned development, contact known vendors whose developers contributed to the release and ask them if there are organizations that funded any of those enhancements. If the majority of the code was merged for a particular web client sprint, be sure to include the funders of that sprint.
  • For individuals who contributed code, management, translations, documentation patches and tests to this release:
    • 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 contributors responsible for managing or building the release.
    • 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 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, 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.

Point Release Notes

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.1512152567.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.