diff options
author | Marco Miller <marco.miller@ericsson.com> | 2020-09-29 15:42:23 -0400 |
---|---|---|
committer | Marco Miller <marco.miller@ericsson.com> | 2020-09-29 17:23:38 -0400 |
commit | 51e1f7d09f68770487b3477ca15f5a6c428c8c19 (patch) | |
tree | 120328ed7e4f07e1ab843b6570123f935e95c58b | |
parent | f5c5b58fdfea886c5a8fa933c63f5e029a846f87 (diff) |
Documentation: Make some dev-release notes steps happen sooner
Move some of the release notes preparation steps, so they start sooner
in the release process. Move those few parts to a new page section
closer to the beginning. Add some contextual paragraphs to that section,
also meant to explain how the uploaded change should be handled and why.
Furthermore, clarify how (and why) the related Issues should be handled.
Change-Id: I7041720bdab2598cb8dabf7b2b36817f5a9a8253
-rw-r--r-- | Documentation/dev-release.txt | 53 |
1 files changed, 35 insertions, 18 deletions
diff --git a/Documentation/dev-release.txt b/Documentation/dev-release.txt index 21df7f9166..2cd9536ec8 100644 --- a/Documentation/dev-release.txt +++ b/Documentation/dev-release.txt @@ -67,6 +67,40 @@ a `security-fix` release has been published will the commits/tags made in the `gerrit-security-fixes` project be taken over into the public `gerrit` project. +[[upload-final-release-notes]] +== Upload the final Release Notes change + +Upload a change on the homepage project to: + +* Remove 'In Development' caveat from the relevant section. + +* Add links to the released documentation and the .war file, and make the +latest version bold. + +The uploaded change is not to be approved yet, but rather act as the +release content review thread until it can be finalized. + +[[update-links]] +=== Update homepage links + +Upload a change on the link:https://gerrit-review.googlesource.com/admin/repos/homepage[ +homepage project] to change the version numbers to the new version. + +[[update-issues]] +=== Update the Issues + +Update the issues by hand. There is no script for this. + +Our current process is an issue should be updated to say `Status = +Submitted, FixedIn-$version` once the change is submitted, but before the +release. + +The updated issues are the ones listed in commit messages since the +previous version tag. Mention each updated issue in the uploaded change, +following the examples from the previous version notes. Add updated issue +owners as reviewers of the uploaded change. More reviewers can be added +or cc'ed, to further coordinate the final release contents. + == Create the Actual Release [[update-versions]] @@ -288,28 +322,11 @@ gerrit-documentation] storage bucket. [[finalize-release-notes]] === Finalize the Release Notes -Upload a change on the homepage project to: - -* Remove 'In Development' caveat from the relevant section. - -* Add links to the released documentation and the .war file, and make the -latest version bold. - -[[update-links]] -==== Update homepage links - -Upload a change on the link:https://gerrit-review.googlesource.com/admin/repos/homepage[ -homepage project] to change the version numbers to the new version. +Submit that previously uploaded change on the homepage project. [[update-issues]] ==== Update the Issues -Update the issues by hand. There is no script for this. - -Our current process is an issue should be updated to say `Status = -Submitted, FixedIn-$version` once the change is submitted, but before the -release. - After the release is actually made, you can search in Google Code for `Status=Submitted FixedIn=$version` and then batch update these changes to say `Status=Released`. Make sure the pulldown says `All Issues` |