Skip to content

document how to handle the docs when releasing #94

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
merged 1 commit into from
Sep 23, 2025
Merged

document how to handle the docs when releasing #94

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
9 changes: 9 additions & 0 deletions docs/content/contributing/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,15 @@ tag represents where the corresponding `release/v0.X` branch branches off.
1. Create the release branch: `git checkout -B release-v0.X`
1. Push the release branch: `git push -u upstream release-v0.X`

Once the tag and branch have been pushed, the documentation has to be manually
updated to include the new minor release.

1. Navigate to https://github.com/kcp-dev/api-syncagent/actions/workflows/docs-gen-and-push.yaml
1. Run the workflow manually on the new release branch.

Within a few minutes of the action finishing, the new branch should show up on
https://docs.kcp.io/api-syncagent/.

## Patch Releases

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