You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@polaris.apache.org by ad...@apache.org on 2026/03/31 06:08:27 UTC

(polaris) 01/01: Update Generated Helm Docs after First RC

This is an automated email from the ASF dual-hosted git repository.

adnan pushed a commit to branch ahemani/update_helm_docs_after_first_rc_main
in repository https://gitbox.apache.org/repos/asf/polaris.git

commit 692c61db77d6623173482ca7a666cc82fed16be9
Author: adnanhemani <ad...@berkeley.edu>
AuthorDate: Mon Mar 30 22:43:20 2026 -0700

    Update Generated Helm Docs after First RC
---
 .github/workflows/release-2-update-release-candidate.yml | 13 +++++++++++++
 releasey/libs/_constants.sh                              |  1 +
 2 files changed, 14 insertions(+)

diff --git a/.github/workflows/release-2-update-release-candidate.yml b/.github/workflows/release-2-update-release-candidate.yml
index a07d742782..0ae2817cb7 100644
--- a/.github/workflows/release-2-update-release-candidate.yml
+++ b/.github/workflows/release-2-update-release-candidate.yml
@@ -145,6 +145,12 @@ jobs:
           distribution: 'temurin'
           java-version: '21'
 
+      - name: Set up helm-docs
+        if: env.rc_number == '0'
+        run: |
+          go install github.com/norwoodj/helm-docs/cmd/helm-docs@latest
+          echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
+
       - name: Update project versions
         if: env.rc_number == '0'
         run: |
@@ -167,6 +173,12 @@ jobs:
           Changelog patched successfully
           EOT
 
+      - name: Generate Helm documentation
+        if: env.rc_number == '0'
+        run: |
+          source "${LIBS_DIR}/_exec.sh"
+          exec_process make helm-doc-generate
+
       - name: Commit and push changes
         if: env.rc_number == '0'
         run: |
@@ -180,6 +192,7 @@ jobs:
             "$HELM_README_FILE" \
             "$HELM_VALUES_FILE" \
             "$HELM_VALUES_SCHEMA_FILE" \
+            "$HELM_REFERENCE_DOC_FILE" \
             "$CHANGELOG_FILE"
           exec_process git commit -m "[chore] Bump version to ${version_without_rc}"
 
diff --git a/releasey/libs/_constants.sh b/releasey/libs/_constants.sh
index d6fa9f3026..9be7a0bafb 100644
--- a/releasey/libs/_constants.sh
+++ b/releasey/libs/_constants.sh
@@ -40,3 +40,4 @@ HELM_CHART_YAML_FILE="$LIBS_DIR/../../helm/polaris/Chart.yaml"
 HELM_README_FILE="$LIBS_DIR/../../helm/polaris/README.md"
 HELM_VALUES_FILE="$LIBS_DIR/../../helm/polaris/values.yaml"
 HELM_VALUES_SCHEMA_FILE="$LIBS_DIR/../../helm/polaris/values.schema.json"
+HELM_REFERENCE_DOC_FILE="$LIBS_DIR/../../site/content/in-dev/unreleased/helm-chart/reference.md"