Matrix-Mirrors
/
mjolnir
mirror of https://github.com/matrix-org/mjolnir.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update releasing instructions (#502)

This commit is contained in:
Shay 2024-01-23 21:29:43 -08:00 committed by GitHub
parent e1bce73ff9
commit 5e35efd1db
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
releasing.md
View File

@ -1,11 +1,11 @@
# Releasing mjolnir
1. Create a new branch and edit the `version` variable of `package.json` to reflect the new version
2. Once that branch has been merged, switch back to the main branch and pull in the new changes
3. Tag the new version, ie `git tag -s vX.Y.Z` (where vX.Y.Z is the new version), and push the tag
4. Once the tag has been pushed, draft a new release on github: https://github.com/matrix-org/mjolnir/releases/new,
using the Generate release notes button to automatically create the release notes/changelog
5. Double-check that everything is correct and make any changes as necessary, then publish the release
6. Publishing the release should kick off a Github Action to build and push the release to Dockerhub -
verify that this did occur successfully
1. Make sure all the things you want have landed on the main branch.
2. Run yarn version --patch (or --minor or --major, see documentation) to create the tag and update the versioning.
3. Push main and the tag to the repo (e.g. git push --atomic origin main v1.3.0).
4. Docker Hub will automatically start building the images required.
5. Create a new github release, freehanding the changelog from a prior release (copy/paste, edit as needed). Github's
auto-changelog is good to press at the beginning to make sure you don't miss anything. Remember to check recently
closed issues and thank the reporters.
6. Update the room topic of #mjolnir:matrix.org to mention the latest version.