Skip to content

ci: regenerate chart README in app version and release PRs - #305

Merged
jordan-simonovski merged 2 commits into
mainfrom
jordansimonovski/app-version-regen-readme
Nov 10, 2026
Merged

jordan-simonovski merged 2 commits into
mainfrom
jordansimonovski/app-version-regen-readme

Conversation

@jordan-simonovski

Copy link
Copy Markdown
Contributor

App version bump PRs fail Helm Chart Tests because the docs-check added in #232 finds a stale charts/clickstack/README.md. The otel-collector image tag appears in the README, and the bump workflow never regenerates it, so #295 had to be fixed by hand. Both automated PR flows now run make docs before they open their PR.

  • The update-app-version workflow regenerates the README after bumping the tag.
  • The version script that changesets/action runs now ends with make docs. The release PR bumps the chart version, which shows in the README version badge, so the next release PR would have failed the same way.

The chart itself doesn't change. make docs downloads helm-docs into .tools/, which is gitignored, so neither PR picks up the binary.

@jordan-simonovski
jordan-simonovski requested a review from a team as a code owner November 9, 2026 23:28
@changeset-bot

changeset-bot Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 11cde40

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

Helm template coverage

Metric Value
Line coverage 99.85%
Branch coverage 91.24%
Line threshold 99% (met)
Branch threshold 90% (met)
Uncovered details

charts/clickstack/templates/NOTES.txt

Uncovered lines: none

Uncovered branches: 37:default:fallback

charts/clickstack/templates/_helpers.tpl

Uncovered lines: 17

Uncovered branches: 111:or(1):true, 128:range:empty, 159:default:fallback, 160:or(1):true, 16:if:true, 176:if:false

charts/clickstack/templates/additional-manifests.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/clickhouse/cluster.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/clickhouse/keeper.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/hyperdx/configmap.yaml

Uncovered lines: none

Uncovered branches: 12:range:empty

charts/clickstack/templates/hyperdx/cronjob-check-alerts.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/hyperdx/dashboard-configmap.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/hyperdx/dashboard-provisioner-rbac.yaml

Uncovered lines: none

Uncovered branches: 40:range:empty

charts/clickstack/templates/hyperdx/deployment.yaml

Uncovered lines: none

Uncovered branches: 117:default:fallback, 127:default:fallback, 150:if:false, 169:and(2):false, 16:with:empty, 192:default:fallback, 197:with:empty, 22:default:fallback, 38:with:empty

charts/clickstack/templates/hyperdx/hpa.yaml

Uncovered lines: none

Uncovered branches: 16:with:empty

charts/clickstack/templates/hyperdx/ingress.yaml

Uncovered lines: none

Uncovered branches: 35:if:false, 40:range:empty, 45:range:empty, 48:with:empty, 54:range:empty, 58:range:empty, 59:or(2):true, 59:or(3):true

charts/clickstack/templates/hyperdx/networkpolicy.yaml

Uncovered lines: none

Uncovered branches: 11:with:empty

charts/clickstack/templates/hyperdx/pdb.yaml

Uncovered lines: none

Uncovered branches: 10:with:empty

charts/clickstack/templates/hyperdx/secret.yaml

Uncovered lines: none

Uncovered branches: 13:range:empty, 1:or(2):true, 1:or(3):true

charts/clickstack/templates/hyperdx/service.yaml

Uncovered lines: none

Uncovered branches: 14:default:fallback, 9:with:empty

charts/clickstack/templates/hyperdx/serviceaccount.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/mongodb/community.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/mongodb/password-secret.yaml

Uncovered lines: none

Uncovered branches: none

charts/clickstack/templates/otel-collector/custom-config.yaml

Uncovered lines: none

Uncovered branches: none

@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

Deep Review

Scope: 2 files (.github/workflows/update-app-version.yml, package.json) against base fb991e67. Single commit — a CI/build-automation change with no chart template, values, or test changes.

Intent: Make both automated PR flows regenerate the chart README (make docs) so the docs-check CI step stops failing on stale READMEs.

✅ No critical issues found.

I verified the mechanics end-to-end: make docs self-installs the pinned helm-docs binary into gitignored .tools/ and needs neither helm nor built chart dependencies, so the bare step works in a fresh ubuntu-latest checkout and inside changesets/action. In update-app-version.yml the step is correctly ordered after the Chart.yaml/values.yaml sed edits and before changeset creation, and both the create-pull-request action and changesets/action commit the regenerated README into their PRs. The only prior review comment is an automated changeset-bot notice (no human feedback to verify).

🟡 P2 — recommended

  • package.json:11 — The release version script now ends with make docs, which downloads the helm-docs binary from GitHub Releases during release-PR creation; a transient registry/network failure there now fails the whole changeset version step rather than just a doc-regen check.
    • Fix: Rely on the existing CI docs-check as the backstop, or cache/pre-install helm-docs in the release job so the critical path does not depend on a live download.
🔵 P3 nitpicks (1)
  • .github/workflows/update-app-version.yml:57 — The generated PR body states only charts/clickstack/README.md was regenerated, but make docs regenerates both chart READMEs (clickstack and clickstack-operators); the body understates the scope of any change the step could introduce.
    • Fix: Reword the PR-body bullet to say the chart README(s) were regenerated, or drop the specific filename.

Reviewers (4): correctness, reliability, maintainability, project-standards.

Testing gaps: None applicable — the change is workflow/packaging configuration not exercised by helm-unittest; the docs-check CI step already validates that regenerated READMEs are current.

No finding blocks merge automatically. A maintainer will expect P0/P1 findings in code this PR changes to be fixed; P2/P3 are your call -- fix or reply. Never fix findings about surrounding code here; reply instead. Do not widen the PR.

@jordan-simonovski
jordan-simonovski merged commit c6d1807 into main Nov 10, 2026
8 checks passed
@jordan-simonovski
jordan-simonovski deleted the jordansimonovski/app-version-regen-readme branch November 10, 2026 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants