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

dev-docs: document minor release #199

Merged
merged 2 commits into from
Mar 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ changelog:
- bug fix
- title: 🔧 Other changes
labels:
- "*"
- changelog
31 changes: 30 additions & 1 deletion dev-docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,34 @@

# Minor

1. Ensure all needed PRs were were merged.

2. Export the release you want to make:

```sh
export REL_VER=v0.1.0
export CUR_VER="$(echo $REL_VER | awk -F. -v OFS=. '{$NF -= 1 ; print}')"
echo "Releasing $CUR_VER -> $REL_VER"
```
3. Create a new temporary branch for the relese:

```sh
git switch -c "tmp/$REL_VER"
git push
```

4. Trigger the release workflow

```sh
gh workflow run release.yml --ref $(git rev-parse --abbrev-ref HEAD) -f kind=minor -f version="$REL_VER"
```
5. Review the release notes, test the binary artifact.

6. Review and merge the auto-generated update PR for main.

7. Publish the GitHub release.

8. Check that the release publish action succeeds.

# Patch

Expand All @@ -12,7 +40,6 @@
```sh
export REL_VER=v0.1.1
export CUR_VER="$(echo $REL_VER | awk -F. -v OFS=. '{$NF -= 1 ; print}')"

echo "Releasing $CUR_VER -> $REL_VER"
```
3. Checkout the current release branch:
Expand All @@ -36,3 +63,5 @@
6. Review the release notes, test the binary artifact.

7. Publish the GitHub release.

8. Check that the release publish action succeeds.
Loading