Skip to content

docs: pin chart versions and drop auto-updating version embeds [sc-20935] - #300

Open
devkoriel wants to merge 1 commit into
mainfrom
sc-20935-pin-validator-chart-version
Open

devkoriel wants to merge 1 commit into
mainfrom
sc-20935-pin-validator-chart-version

Conversation

@devkoriel

Copy link
Copy Markdown
Contributor

Stops the validator docs from changing on their own when a new chart version is published. Story: https://app.shortcut.com/chronicle-labs/story/20935

Why

quickstart, existing-k8s and upgrading embedded a shields.io badge that reads the newest validator version from the chart index in the browser, plus an Artifact Hub widget that shows the latest version. They currently show 0.8.0 while every command on the same pages pins 0.6.11. Script downloads followed scripts main, so a merge there could change what operators run without a docs change.

What changed

  • Badge and widget replaced with a static Validator chart version: 0.6.11 line and a note to install exactly that version.
  • install.sh / upgrade.sh downloads and the keystore-generator and kubeconfig links point at scripts commit 5e1970c5, which sets CHART_VERSION="0.6.11".
  • Chart source and values links point at tag validator-0.6.11 instead of main.
  • "latest version" wording now names the pinned version; the sample install banner matches what the pinned script prints.
  • Challenger guide: same fix (its widget showed 0.1.1 while the page installs 0.1.0); links point at tag challenger-0.1.0.

Bumping the version later

This is now a deliberate change. grep -rn '0\.6\.11\|5e1970c5' docs/validators lists every place to update together.

Testing

  • yarn build (Docusaurus): pass, no broken links.
  • Built HTML: no img.shields.io dynamic badge or artifacthub-widget on any page.
  • Pinned raw script URLs return HTTP 200 with CHART_VERSION="0.6.11".

…935]

The shields.io badge and Artifact Hub widgets rendered the latest published
chart version, which contradicted the pinned install commands on the
validator and challenger pages. Replace them with a static pinned version.

Script downloads and chart links now point at a fixed scripts commit and
chart tags, so a merge elsewhere cannot change what operators run without
a docs change.
@devkoriel devkoriel added the documentation Improvements or additions to documentation label Sep 17, 2026
@devkoriel devkoriel self-assigned this Sep 17, 2026
@vercel

vercel Bot commented Sep 17, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
documentation Ready Ready Preview Sep 17, 2026 5:31am UTC

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant