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.

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

dev-docs: omit current release mention from minor release #226

Merged
merged 1 commit into from
Mar 11, 2024
Merged

dev-docs: omit current release mention from minor release #226

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
11 changes: 7 additions & 4 deletions dev-docs/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# How to release

# Minor
## 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"
echo "Releasing $REL_VER"
```

3. Create a new temporary branch for the relese:

```sh
Expand All @@ -23,6 +23,7 @@
```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.
Expand All @@ -31,7 +32,7 @@

8. Check that the release publish action succeeds.

# Patch
## Patch

1. Ensure all needed PRs were backported to the current release branch, and all backport PRs were merged.

Expand All @@ -42,6 +43,7 @@
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:

```sh
Expand All @@ -60,6 +62,7 @@
```sh
gh workflow run release.yml --ref $(git rev-parse --abbrev-ref HEAD) -f kind=patch -f version="$REL_VER"
```

6. Review the release notes, test the binary artifact.

7. Publish the GitHub release.
Expand Down