From cb01a605fc4f9e485d3a775915b14667adcfba29 Mon Sep 17 00:00:00 2001 From: Christoph Mewes Date: Tue, 23 Sep 2025 10:41:07 +0200 Subject: [PATCH] document how to handle the docs when releasing On-behalf-of: @SAP christoph.mewes@sap.com --- docs/content/contributing/releasing.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/content/contributing/releasing.md b/docs/content/contributing/releasing.md index 5bead6a..c1ababb 100644 --- a/docs/content/contributing/releasing.md +++ b/docs/content/contributing/releasing.md @@ -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.