Skip to content

Release notes nits #415

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
mjudeikis merged 1 commit into from
Dec 2, 2025
Merged

Release notes nits #415

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
26 changes: 20 additions & 6 deletions docs/content/developers/publishing-a-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,34 +29,48 @@ kube-bind has 3 go modules, and a unique tag is needed for each module every tim

```shell
REF=upstream/main
TAG=v0.5.1
TAG=v0.6.0
git tag --sign --message "$TAG" "$TAG" "$REF"
```

3. Tag the `sdk` module, following the same logic as above for `REF` and `TAG`

```shell
REF=upstream/main
TAG=v0.5.1
TAG=v0.6.0
git tag --sign --message "sdk/$TAG" "sdk/$TAG" "$REF"
```

4. Tag the `cli` module, following the same logic as above for `REF` and `TAG`

```shell
REF=upstream/main
TAG=v0.5.1
TAG=v0.6.0
git tag --sign --message "cli/$TAG" "cli/$TAG" "$REF"
```

### Push the Tags

```shell
REMOTE=upstream
TAG=v0.5.1
TAG=v0.6.0
git push "$REMOTE" "$TAG" "sdk/$TAG" "cli/$TAG"
```

### Create a Release Branch

Set `REMOTE`, `REF`, and `VERSION` as appropriate.

```shell
REMOTE=upstream
REF="$REMOTE/main"
VERSION=0.6 # e.g. 1.2
git checkout -b "release-$VERSION" "$REF"
git push "$REMOTE" "release-$VERSION"
```

Once you tag and push the new release branch, don't forget to run the documentation deployment as described in [Trigger Documentation Deployment](#trigger-documentation-deployment).

## If it's a New Minor Version

If this is the first release of a new minor version (e.g. the last release was v0.7.x, and you are releasing the first
Expand All @@ -79,8 +93,8 @@ To use `release-notes` you will need to generate a GitHub API token (Settings ->
Then, run the `release-notes` tool (set `PREV_VERSION` to the version released before the one you have just released).

```shell
TAG=v0.5.0
PREV_TAG=v0.4.8
TAG=v0.6.0
PREV_TAG=v0.5.1
release-notes \
--required-author='' \
--org kube-bind \
Expand Down