Repository navigation
docs: replace the empty Pages landing page + artifacthub setup - #319
jordan-simonovski wants to merge 5 commits into
Conversation
The site at clickhouse.github.io/ClickStack-helm-charts showed the gh-pages README from the initial commit. The page now lives in pages/ on main and the release job copies it onto gh-pages, committing only when it changed.
🦋 Changeset detectedLatest commit: 95edf90 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Helm template coverage
Uncovered detailscharts/clickstack/templates/NOTES.txtUncovered lines: none Uncovered branches: 37:default:fallback charts/clickstack/templates/_helpers.tplUncovered lines: 17 Uncovered branches: 130:range:empty, 132:range:empty, 133:ternary:false, 16:if:true, 194:or(1):true, 211:range:empty, 242:default:fallback, 243:or(1):true, 259:if:false, 327:range:empty, 348:range:empty charts/clickstack/templates/additional-manifests.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/clickhouse/cluster.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/clickhouse/keeper.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/hyperdx/configmap.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/hyperdx/cronjob-check-alerts.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/hyperdx/dashboard-configmap.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/hyperdx/dashboard-provisioner-rbac.yamlUncovered lines: none Uncovered branches: 40:range:empty charts/clickstack/templates/hyperdx/deployment.yamlUncovered lines: none Uncovered branches: 121:default:fallback, 131:default:fallback, 196:default:fallback, 201:with:empty, 20:with:empty, 26:default:fallback, 41:if:false, 42:with:empty charts/clickstack/templates/hyperdx/hpa.yamlUncovered lines: none Uncovered branches: 16:with:empty charts/clickstack/templates/hyperdx/ingress.yamlUncovered 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.yamlUncovered lines: none Uncovered branches: 11:with:empty charts/clickstack/templates/hyperdx/pdb.yamlUncovered lines: none Uncovered branches: 10:with:empty charts/clickstack/templates/hyperdx/secret.yamlUncovered lines: none Uncovered branches: 1:or(2):true, 1:or(3):true charts/clickstack/templates/hyperdx/service.yamlUncovered lines: none Uncovered branches: 14:default:fallback, 9:with:empty charts/clickstack/templates/hyperdx/serviceaccount.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/mongodb/community.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/mongodb/password-secret.yamlUncovered lines: none Uncovered branches: none charts/clickstack/templates/otel-collector/custom-config.yamlUncovered lines: none Uncovered branches: none |
Deep Review✅ No critical issues found. This PR is docs, chart metadata, and one CI workflow step — no Helm templates or render paths change, the two version bumps are internally consistent, and the one hard-fail path in the new workflow step ( 🟡 P2 — recommended
🔵 P3 nitpicks (5)
Reviewers (6): correctness, project-standards, reliability, security, maintainability, testing. The two prior PR comments are automated bot output (changeset-bot, helm template coverage) with no human feedback to verify, so the previous-comments reviewer was not run. Testing gaps:
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. |
…s-landing # Conflicts: # AGENTS.md
Links the chart repo to the ClickHouse org on Artifact Hub so both charts get the verified publisher badge.
…Artifact Hub Adds an icon, keywords and Artifact Hub category to both charts and replaces the old hyperdxio/helm-charts source links. Bumps clickstack-operators to 1.1.1 so the new metadata gets published.
clickhouse.github.io/ClickStack-helm-charts has shown "Helm Charts for HyperDX OSS V2 / WIP" since the repo was created, because GitHub Pages renders the
gh-pagesREADME and nothing ever updated it. The landing page now explains what ClickStack is, how to install both charts, and where the docs, upgrade guide and releases live.pages/onmain, so edits go through review. The last step of the release job copies it ontogh-pagesand commits only when something changed.README.mdand_config.yml, and runs after chart-releaser in the same serialised job, so it can't raceindex.yamlupdates.Residual risks, not handled here:
{{or{%in a futurepages/edit would fail the Pages build, which also stops newindex.yamlupdates from deploying until fixed. A PR-time Jekyll build would catch it ifpages/grows.pages/doesn't delete it fromgh-pages.Also sets up the Artifact Hub listing under the ClickHouse org:
pages/artifacthub-repo.ymllinks this repo to the org, which gives both charts the verified publisher badge.clickstack-operatorsgoes to 1.1.1, because the release script only bumpsclickstackand chart-releaser skips existing versions. Without the bump, the operators metadata would never be published.Testing
Against a bare clone of this repo: the first run committed
README.mdand_config.ymlbesideindex.yamlandcharts/, and the second run was a no-op. Every link on the page returns 200. The real push from the runner and the Pages rebuild happen on the first release run after merge.