Skip to content

fix naming of release branches in docs #132

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
kcp-ci-bot merged 1 commit into from
Feb 10, 2026
Merged

fix naming of release branches in docs #132

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
8 changes: 4 additions & 4 deletions docs/content/contributing/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ The guide describes how to release a new version of the api-syncagent.
## Minor Release

Minor releases (0.x) are tagged directly on the `main` branch and the `v0.X.0`
tag represents where the corresponding `release/v0.X` branch branches off.
tag represents where the corresponding `release-0.X` branch branches off.

1. Checkout the desired `main` branch commit.
1. Tag the main module: `git tag -m "version 0.X" v0.X.0`
1. Tag the SDK module: `git tag -m "SDK version 0.X" sdk/v0.X.0`
1. Push the tags: `git push upstream v0.X.0 sdk/v0.X.0`
1. Create the release branch: `git checkout -B release-v0.X`
1. Push the release branch: `git push -u upstream release-v0.X`
1. Create the release branch: `git checkout -B release-0.X`
1. Push the release branch: `git push -u upstream release-0.X`

Once the tag and branch have been pushed, the documentation has to be manually
updated to include the new minor release.
Expand All @@ -32,7 +32,7 @@ https://docs.kcp.io/api-syncagent/.

Patch releases (v0.x.y) are tagged with in a release branch.

1. Checkout the desired `release/v0.X` branch commit.
1. Checkout the desired `release-0.X` branch commit.
1. Tag the main module: `git tag -m "version 0.X.Y" v0.X.Y`
1. Tag the SDK module: `git tag -m "SDK version 0.X.Y" sdk/v0.X.Y`
1. Push the tags: `git push upstream v0.X.Y sdk/v0.X.Y`