Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some releasing instructions #500

Merged
merged 1 commit into from
Nov 15, 2023
Merged

Add some releasing instructions #500

merged 1 commit into from
Nov 15, 2023

Conversation

H-Shay
Copy link
Contributor

@H-Shay H-Shay commented Nov 14, 2023

No description provided.

Copy link
Member

@turt2live turt2live left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you!

@H-Shay H-Shay merged commit e1bce73 into main Nov 15, 2023
5 checks passed
@H-Shay
Copy link
Contributor Author

H-Shay commented Nov 15, 2023

Merged #500 into main, thanks for the swift review!


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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@H-Shay There should be a Mjolnir wiki within the Element wiki (if such a thing still exists), I'm not sure why these were never transferred to this repository but there were instructions for how to release Mjolnir there that are still accurate. Mjolnir was released with the yarn version script to ensure that the version in package.json, the version within the synapse module, and the git tag are all synchronised without causing a mistake from typos (this has happened previously). There were also instructions for how to push the release commit and the tag atomically so that someone new wouldn't push only one or the other.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the insight! I've found the entry.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants