From 9cdd4e6a73d99017316b51d7b9c2bf6fafd49217 Mon Sep 17 00:00:00 2001 From: Lars Kiesow Date: Wed, 20 Nov 2024 23:40:09 +0100 Subject: [PATCH] Update documentation about how to create a release This patch updates the documentation about how to create a release. While the process is mostly the same, it is slightly different by now. This patch reflects the changes by updating our release manager guide. --- .../docs/participate/release-manager.md | 69 ++++++------------- 1 file changed, 22 insertions(+), 47 deletions(-) diff --git a/docs/guides/developer/docs/participate/release-manager.md b/docs/guides/developer/docs/participate/release-manager.md index fd013d90d9f..0bf18cfa947 100644 --- a/docs/guides/developer/docs/participate/release-manager.md +++ b/docs/guides/developer/docs/participate/release-manager.md @@ -307,26 +307,26 @@ needs to be done manually. The following steps outline the necessary steps for cutting the final release: -1. Switch to and update your release branch and ensure the latest state of the previous release branch is merged: +0. Switch to and update your local release branch. - git checkout r/6.x - git fetch - git merge /r/6.x - git merge /r/5.x - -2. Add the release notes, and update the changelog. The `create-changelog` [helper script +1. Add the release notes, and update the changelog. The `create-changelog` [helper script ](https://github.com/opencast/helper-scripts/tree/master/release-management/create-changelog) is a convenient tool - for this. + for this. You need to update: + + - `docs/guides/admin/docs/releasenotes.md` + - `docs/guides/admin/docs/changelog.md` + + Create a pull request for the updated documentation and merge it. - cd docs/guides/admin/docs/ - vim releasenotes.md - vim changelog.md - git commit -S releasenotes.md changelog.md -m 'Updated Release Notes' - git push r/6.x +2. Update your local release branch yet again, so that it contains the documentation: + + git checkout r/16.x + git fetch + git merge /r/16.x 3. Switch to a new branch to create the release (name does not really matter): - git checkout -b tmp-6.0 + git checkout -b tmp-16.0 4. Make the version changes for the release: @@ -335,17 +335,18 @@ The following steps outline the necessary steps for cutting the final release: 5. Have a look at the changes. Make sure that nothing else was modified: git diff - git status | grep modified: | grep -v pom.xml # this should yield no output + # The following command should yield no output: + git status | grep modified: | grep -v pom.xml 6. Commit the changes and create a release tag: git add $(git status | grep 'modified:.*pom.xml' | awk '{print $2;}') - git commit -S -m 'Opencast 6.0' - git tag -s 6.0 + git commit -S -m 'Opencast 16.0' + git tag -s 16.0 -m 'Opencast 16.0' 7. Push the tag to the community repository (you can remove the branch afterwards): - git push 6.0:6.0 + git push 16.0 8. Check the “Create new release” GitHub Actions workflow. It will automatically build and upload the release tarballs and create a new release draft. @@ -354,38 +355,12 @@ The following steps outline the necessary steps for cutting the final release: If the workflow fails, investigate what was going wrong and either restart the workflow or create the release manually in the GitHub user interface. -9. Check that the release is published on [Maven Central](https://repo1.maven.org/maven2/org/opencastproject/opencast-common/). +9. Post a release notification on [opencast.org](https://opencast.org). + +10. Check that the release is published on [Maven Central](https://repo1.maven.org/maven2/org/opencastproject/opencast-common/). This can take some time, and is done via [Buildbot](http://ci.opencast.org). If in doubt, ask the QA Coordinator to check. If you need to do this yourself please read the [infra documentation](infrastructure/maven-repository.md#pushing-to-maven-central). -Finally, send a release notice to Opencast's announcement list. Note that posting to this list is restricted to those -who need access to avoid general discussions on that list. In case you do not already have permissions to post on this -list, please ask to be given permission. For the message, you may use the following template: - -```no-highlight -To: announcements@opencast.org -Subject: Opencast Released - -Hi everyone, -it is my pleasure to announce that Opencast has -been released: - - https://github.com/opencast/opencast/releases - -The documentation for this release can be found at: - - https://docs.opencast.org/r//admin/ - -RPM and Debian packages as well as Docker images will be -available soon. Watch for announcements on the users list. - -To all committers and involved contributors, thank you for -all your work. This could not have happened without you and -I am glad we were able to work together and get this release -out. -``` - - ### Appointment of Next Release Manager After the release branch is cut, all work on `develop` is effectively the preparation for the next release. At this