Skip to content

Update release procedure #137

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
Jan 25, 2024
Merged

Update release procedure #137

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
13 changes: 10 additions & 3 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,14 @@ git checkout main
# Stash any untracked + uncomitted changes
git stash -u

# Run the build once to make sure it completes without errors
pnpm run build
# Run the unit tests
pnpm test

# Run the Visual Regression Tests in CI mode
pnpm test:visual --ci

# Review changes in order to decide which release-increment to use
git log --first-parent main...v<last-version-number>

# Mark the version update
# This creates a new tagged commit for the version
Expand Down Expand Up @@ -43,6 +49,7 @@ git stash pop
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**.
- Move any changes specific to performance to a new level 3 heading called: **Performance**
- If there are other 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"