Skip to content

Commit

Permalink
dev-docs: document minor release
Browse files Browse the repository at this point in the history
Signed-off-by: Paul Meyer <[email protected]>
  • Loading branch information
katexochen committed Mar 6, 2024
1 parent 3eac02f commit 6dd666c
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion dev-docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,30 @@

# 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. Publish the GitHub release.

# Patch

Expand All @@ -12,7 +36,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 Down

0 comments on commit 6dd666c

Please sign in to comment.