Skip to content

Add an index.html pointing at index.yaml - #562

Open
arska wants to merge 1 commit into
gh-pagesfrom
add/chart-repo-index-page
Open

Add an index.html pointing at index.yaml#562
arska wants to merge 1 commit into
gh-pagesfrom
add/chart-repo-index-page

Conversation

@arska

@arska arska commented Sep 4, 2026

Copy link
Copy Markdown
Member

Why

A Helm repository's only contract is index.yaml. Nothing ever requests /, so what / returns has never said anything about whether the repository works.

That is not hypothetical. An external link audit of the VSHN estate classified every hostname by what / returned, and read this host by that answer alone. The repository was serving its index correctly the entire time.

What this adds

An index.html on gh-pages showing:

  • the helm repo add / update / search commands
  • how to install a chart from the repository
  • links to the chart sources, the raw index.yaml, and the product documentation

Someone who types the hostname now learns what it is and how to use it.

Not a redirect

An earlier revision of this PR redirected to index.yaml. Changed on review: sending a person to raw YAML proves the repository is alive but tells them less than the command they came for. Helm is unaffected either way, since it never requests /.

Why it is safe on a generated branch

gh-pages is written by helm/chart-releaser-action, which adds packages and updates index.yaml but never cleans the branch. CNAME and README.md have survived there across many releases on exactly those terms, which is the evidence rather than the assumption.

The file carries an HTML comment stating it is hand-maintained and why, so the next person does not assume it is generated output and delete it.

Verifying

After merge, / should render the page, and helm repo add should be unchanged. Rendered locally before pushing rather than checked by reading the markup.

A Helm repository's only contract is index.yaml. Nothing ever requests "/", so
what "/" returns has never said anything about whether the repository works.

That is not hypothetical. An external link audit of the VSHN estate classified
every hostname by what "/" returned, and read this host by that answer alone.
The repository was serving its index correctly the whole time.

This adds a small landing page showing the `helm repo add` command, how to
install from the repository, and links to the chart sources, the raw index.yaml
and the product documentation. Someone who types the hostname now learns what it
is and how to use it.

Deliberately not a redirect to index.yaml. Sending a person to raw YAML proves
the repository is alive but tells them less than the command they came for.

Hand-maintained on gh-pages rather than generated: helm/chart-releaser-action
adds packages and updates index.yaml but never cleans the branch, which CNAME
and README.md have already demonstrated across many releases. The file carries a
comment saying so, so the next person does not assume it is generated output and
delete it.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013Qi4cDMUdzWcNxTGef1634
Signed-off-by: Aarno Aukia <aarno.aukia@vshn.ch>
@arska
arska force-pushed the add/chart-repo-index-page branch from 2e05317 to 6f720c1 Compare September 4, 2026 05:35
@arska arska self-assigned this Sep 4, 2026
@arska
arska requested a review from BacLuc September 4, 2026 07:12
@arska

arska commented Sep 4, 2026

Copy link
Copy Markdown
Member Author

@BacLuc any possible objection to putting a small page on https://charts.appuio.ch/, so it doesn't return a 404 error? My VSHN-wide link checker flagged it :)

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.

1 participant