Skip to content

Commit 44b1b6f

Browse files
committed
Updating release instructions
1 parent 4ebc58b commit 44b1b6f

1 file changed

Lines changed: 36 additions & 14 deletions

File tree

README.md

Lines changed: 36 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -56,31 +56,53 @@ If you aim to test against a remote server without using a proxy, you have the o
5656
NODE_ENV=development VITE_TEST_SERVER_URL="https://develop.opencast.org" VITE_TEST_SERVER_AUTH="admin:opencast" npm start
5757
```
5858

59-
How to cut a release for Opencast
60-
---------------------------------
59+
60+
How to cut a release for Opencast via the Github UI
61+
---------------------------------------------------
62+
63+
1. (Optional) Run the GitHub Actions workflow [Crowdin » Download translations
64+
](https://github.com/opencast/opencast-admin-interface/actions/workflows/crowdin-download-translations.yml)
65+
to ensure all changes from Crowdin are included in the new release.
66+
67+
2. Use the [Create release tag](https://github.com/opencast/opencast-admin-interface/actions/workflows/create-release.yml)
68+
workflow to create a correctly named tag in the appropriate branch. When running the workflow via the dropdown
69+
ensure you select the correct branch for the release!
70+
71+
3. Wait for the [Process release](https://github.com/opencast/opencast-admin-interface/actions/workflows/process-release.yml)
72+
workflow to finish
73+
- It will create a new [GitHub release](https://github.com/opencast/opencast-admin-interface/releases)
74+
- Review the release and make sure the notes are right, update them if not.
75+
- By selecting the previous release, Github can generate release notes automatically
76+
- This review isn't required to happen prior to the next step!
77+
78+
5. Merge the upstream issue that the workflow above filed in [Opencast's main repository](https://github.com/opencast/opencast)
79+
80+
81+
How to cut a release for Opencast manually with git
82+
---------------------------------------------------
6183

6284
1. (Optional) Run the GitHub Actions workflow [Crowdin » Download translations
6385
](https://github.com/opencast/opencast-admin-interface/actions/workflows/crowdin-download-translations.yml)
6486
to ensure all changes from Crowdin are included in the new release.
6587

66-
2. Switch to the commit you want to turn into the release
88+
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
6789

6890
3. Create and push a new tag
69-
```sh
70-
DATE=$(date +%Y-%m-%d)
71-
git tag -s -m "Release ${DATE}" "${DATE}"
72-
git push upstream "${DATE}"
91+
```bash
92+
BRANCH=N.x (make sure the version you write here matches the branch you have checked out)
93+
DATE=$(date +%Y-%m-%d)
94+
git tag -sm "Release $BRANCH-$DATE" -s "$BRANCH-$DATE"
95+
git push upstream "$BRANCH-$DATE":"$BRANCH-$DATE"
7396
```
7497

75-
4. Wait for the [Create release draft](https://github.com/opencast/opencast-admin-interface/actions/workflows/create-release.yml)
98+
4. Wait for the [Process release](https://github.com/opencast/opencast-admin-interface/actions/workflows/process-release.yml)
7699
workflow to finish
77-
- It will create a new [GitHub release draft](https://github.com/opencast/opencast-admin-interface/releases)
78-
- Review and publish the draft
79-
- By selecting the previous release, Github can generate release notes automatically
100+
- It will create a new [GitHub release](https://github.com/opencast/opencast-admin-interface/releases)
101+
- Review the release and make sure the notes are right, update them if not.
102+
- By selecting the previous release, Github can generate release notes automatically
103+
- This review isn't required to happen prior to the next step!
80104

81-
5. Submit a pull request against Opencast
82-
- [Update the release](https://github.com/opencast/opencast/blob/542fc1f82181d1d4712ac8fc06c5ea9e16ae4033/modules/admin-ui-interface/pom.xml#L16-L17)
83-
- Verify that the new release runs in Opencast, then create the pull request.
105+
5. Merge the upstream issue that the workflow above filed in [Opencast's main repository](https://github.com/opencast/opencast)
84106

85107

86108
Translating the Admin Interface

0 commit comments

Comments
 (0)