Skip to content

Update Release Procedure #71

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.

Sign up for GitHub

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

Merged
frank-weindel merged 1 commit into from
Oct 31, 2023
Merged

Update Release Procedure #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ pnpm publish --access public
git push

# Push version tag to github
git push vX.X.X
git push origin vX.X.X

# Pop the stash (if one was created)
git stash pop
Expand All @@ -40,6 +40,9 @@ git stash pop
3. Target: _main_
4. Name the release with the same name as the tag: vX.X.X
5. Click "Generate release notes"
6. Edit the release notes as appropriate.
6. Edit the release notes as appropriate:
- User facing changes should go under the main "What's Changed" heading
- Mark all breaking changes with: :warning: **Breaking Change:** (Description)
- If there are non-user facing changes move them to a new level 3 heading called: **Non-User Facing**.
7. Set as the latest release: _Check_
8. Click "Publish release"