Skip to content

Commit db3f595

Browse files
authored
Merge pull request #94 from kcp-dev/improve-release-docs
document how to handle the docs when releasing
2 parents 2488477 + cb01a60 commit db3f595

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/content/contributing/releasing.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,15 @@ tag represents where the corresponding `release/v0.X` branch branches off.
1919
1. Create the release branch: `git checkout -B release-v0.X`
2020
1. Push the release branch: `git push -u upstream release-v0.X`
2121

22+
Once the tag and branch have been pushed, the documentation has to be manually
23+
updated to include the new minor release.
24+
25+
1. Navigate to https://github.com/kcp-dev/api-syncagent/actions/workflows/docs-gen-and-push.yaml
26+
1. Run the workflow manually on the new release branch.
27+
28+
Within a few minutes of the action finishing, the new branch should show up on
29+
https://docs.kcp.io/api-syncagent/.
30+
2231
## Patch Releases
2332

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

0 commit comments

Comments
 (0)