From fe51c2c8cbeeb527f5770af8a60f2007f2594bf6 Mon Sep 17 00:00:00 2001 From: Greg Logan Date: Thu, 9 Oct 2025 18:38:16 -0600 Subject: [PATCH] Updating release instructions --- README.md | 49 +++++++++++++++++++++++++++++++++---------------- 1 file changed, 33 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 90931b254..11674f7b2 100644 --- a/README.md +++ b/README.md @@ -89,33 +89,50 @@ Options which are usually specified in the configuration file are documented in | debug | ✓ | ✗ | Enable internationalization debugging. | | lng | ✓ | ✗ | Select a specific language. Use language codes like `de` or `en-US`. | -How to cut a release for Opencast ---------------------------------- + +How to cut a release for Opencast with the Github UI +---------------------------------------------------- 1. (Optional) Run the [Update translations](https://github.com/opencast/opencast-editor/actions/workflows/update-translations.yml) workflow, to make sure all changes from crowdin are included in the next release. -1. Run the [Create release tag](https://github.com/opencast/opencast-editor/actions/workflows/create-release.yml) workflow from the branch you want to release. + +2. Run the [Create release tag](https://github.com/opencast/opencast-editor/actions/workflows/create-release.yml) + workflow to create a correctly named tag in the appropriate branch. When running the workflow via the dropdown + ensure you select the correct branch for the release! - This will create the tag in the forman N.x-YYYY-MM-DD - - It will then create a new [GitHub release](https://github.com/opencast/opencast-editor/releases) - - Review and edit the release to make sure the release notes are correct - - By selecting the previous release, Github can generate release notes automatically - - Finally it will create an upstream PR to the relevant [Opencast](https://github.com/opencast/opencast) branch incorporating the new release -Cutting manually +3. Wait for the [Process release](https://github.com/opencast/opencast-editor/actions/workflows/process-release.yml) + workflow to finish + - It will create a new [GitHub release](https://github.com/opencast/opencast-editor/releases) + - Review the release and make sure the notes are right, update them if not. + - By selecting the previous release, Github can generate release notes automatically + - This review isn't required to happen prior to the next step! + +5. Merge the upstream issue that the workflow above filed in [Opencast's main repository](https://github.com/opencast/opencast) + + +How to cut a release for Opencast manually with git +--------------------------------------------------- -1. Switch to the commit you want to turn into the release - make sure this is the on `develop` or an `r/N.x` branch -1. Create and push a new tag +1. (Optional) Run the [Update translations](https://github.com/opencast/opencast-editor/actions/workflows/update-translations.yml) workflow, to make sure all changes from crowdin are included in the next release. + +2. Switch to the commit you want to turn into the release - make sure this is the on `develop` or an `r/N.x` branch + +3. Create and push a new tag ```bash BRANCH=N.x (make sure the version you write here matches the branch you have checked out) DATE=$(date +%Y-%m-%d) - git tag -m "Release $BRANCH-$DATE" -s "$BRANCH-$DATE" + git tag -sm "Release $BRANCH-$DATE" -s "$BRANCH-$DATE" git push upstream "$BRANCH-$DATE":"$BRANCH-$DATE" ``` -1. Wait for the [Create release](https://github.com/opencast/opencast-editor/actions/workflows/process-release.yml) + +3. Wait for the [Process release](https://github.com/opencast/opencast-editor/actions/workflows/process-release.yml) workflow to finish - - It will then create a new [GitHub release](https://github.com/opencast/opencast-editor/releases) - - Review and edit the release to make sure the release notes are correct - - By selecting the previous release, Github can generate release notes automatically - - Finally it will create an upstream PR to the relevant [Opencast](https://github.com/opencast/opencast) branch incorporating the new release + - It will create a new [GitHub release](https://github.com/opencast/opencast-editor/releases) + - Review the release and make sure the notes are right, update them if not. + - By selecting the previous release, Github can generate release notes automatically + - This review isn't required to happen prior to the next step! + +5. Merge the upstream issue that the workflow above filed in [Opencast's main repository](https://github.com/opencast/opencast) Opencast API used by the Editor