From f521006254424285f9cd7a67c199cefbc9529cd7 Mon Sep 17 00:00:00 2001 From: Olivier Michallat Date: Thu, 25 Jul 2024 08:29:52 -0700 Subject: [PATCH] Fix docs check in release process (fixes #1375) --- .../content/en/contribute/releasing/_index.md | 27 +++++++++++++------ 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/docs/content/en/contribute/releasing/_index.md b/docs/content/en/contribute/releasing/_index.md index 59a953a4c..8296e8877 100644 --- a/docs/content/en/contribute/releasing/_index.md +++ b/docs/content/en/contribute/releasing/_index.md @@ -8,12 +8,11 @@ description: "How to perform releases of k8ssandra-operator" ## Prerequisites -[yq](https://github.com/mikefarah/yq) and [Hugo](https://gohugo.io/documentation/) installed. +[yq](https://github.com/mikefarah/yq) installed. With MacOS / Homebrew: ```shell brew install yq -brew install hugo ``` ## Major / Minor Release @@ -74,7 +73,9 @@ git commit -m"Update changelog for v${RELEASED_MAJOR_MINOR?}.0" ```shell cd docs -hugo mod clean + +npm install +npm run clean npm run build:production cd .. @@ -118,10 +119,14 @@ The diff should look like this: version: 0.29.0 ``` -Commit and push the changes: +Commit: ```shell git add config/deployments/default/kustomization.yaml charts/k8ssandra-operator/Chart.yaml git commit -m"Release v${RELEASED_MAJOR_MINOR?}.0" +``` + +Push the changes: +```shell git push ${GIT_REMOTE?} release/${RELEASED_MAJOR_MINOR?} ``` @@ -206,7 +211,7 @@ git cherry-pick -n Amend the merge commit with your cherry-picks: ```shell git add . -git commit --amend +git commit --amend --no-edit ``` Update the version in the release chart: @@ -331,7 +336,9 @@ git commit -m"Update changelog for v${RELEASED_FULL?}" ```shell cd docs -hugo mod clean + +npm install +npm run clean npm run build:production cd .. @@ -375,10 +382,14 @@ The diff should look like this: version: 0.29.0 ``` -Commit and push the changes: +Commit: ```shell git add config/deployments/default/kustomization.yaml charts/k8ssandra-operator/Chart.yaml git commit -m"Release v${RELEASED_FULL?}" +``` + +Push the changes: +```shell git push ${GIT_REMOTE?} release/${RELEASED_MAJOR_MINOR?} ``` @@ -464,7 +475,7 @@ git cherry-pick -n Amend the merge commit with your cherry-picks: ```shell git add . -git commit --amend +git commit --amend --no-edit ``` Push all the changes: