Hi! Loving the v2.6.3 release and the new built-in dashboard. Reporting a small docs-vs-reality gap on the chart-release side.
The chart README and the main repo README both point users at the published helm repository:
helm repo add comqtt https://wind-c.github.io/comqtt
helm install my-broker comqtt/comqtt
In practice the URL is not live yet:
| Check |
Result |
curl https://wind-c.github.io/comqtt/index.yaml |
404 |
gh api /repos/wind-c/comqtt/branches/gh-pages |
404 (branch does not exist) |
gh api /repos/wind-c/comqtt/pages |
404 (Pages not configured on the repo) |
So users following the README will hit a confusing 404 on helm repo add. (For comparison, ghcr.io/wind-c/comqtt:2.6.3 is published correctly — release.yaml is working.)
What likely needs to happen
helm/chart-releaser-action pushes the packaged chart and index.yaml to a gh-pages branch. For that branch to actually be served as a Helm repo, GitHub Pages has to be enabled on the repository.
Two things to check:
- Has
chart-release.yaml ever run successfully? A failed run is the most common cause of a missing gh-pages branch. Worth looking at the Actions tab and confirming a green run exists.
- Is GitHub Pages enabled? Even after
chart-releaser-action pushes to gh-pages, Pages itself has to be enabled with source Branch: gh-pages / (root) in Repo Settings → Pages. The 404 on /repos/.../pages suggests this step is missing.
If the workflow has not run on a tag yet, you can either retag (git tag -f v2.6.3 && git push --force origin v2.6.3) to retrigger, or invoke the workflow manually if it accepts workflow_dispatch.
Manual one-shot alternative (if you don't want to wait for CI)
helm package deploy/helm/comqtt -d .cr-release-packages
git checkout --orphan gh-pages
git rm -rf .
mv .cr-release-packages/comqtt-*.tgz .
helm repo index . --url https://wind-c.github.io/comqtt
git add comqtt-*.tgz index.yaml
git commit -m "Initial chart release"
git push origin gh-pages
# then enable Pages on the repo with source=gh-pages
After that, helm repo add comqtt https://wind-c.github.io/comqtt && helm repo update should work.
Happy to send a PR tightening the README to either (a) hide the helm repo add line until the chart is actually published, or (b) replace it with a helm install oci://... line using the GHCR-published chart (chart-releaser-action also supports OCI distribution). Whichever you prefer, just let me know.
Thanks!
Hi! Loving the v2.6.3 release and the new built-in dashboard. Reporting a small docs-vs-reality gap on the chart-release side.
The chart README and the main repo README both point users at the published helm repository:
In practice the URL is not live yet:
curl https://wind-c.github.io/comqtt/index.yamlgh api /repos/wind-c/comqtt/branches/gh-pagesgh api /repos/wind-c/comqtt/pagesSo users following the README will hit a confusing 404 on
helm repo add. (For comparison,ghcr.io/wind-c/comqtt:2.6.3is published correctly —release.yamlis working.)What likely needs to happen
helm/chart-releaser-actionpushes the packaged chart andindex.yamlto agh-pagesbranch. For that branch to actually be served as a Helm repo, GitHub Pages has to be enabled on the repository.Two things to check:
chart-release.yamlever run successfully? A failed run is the most common cause of a missinggh-pagesbranch. Worth looking at the Actions tab and confirming a green run exists.chart-releaser-actionpushes togh-pages, Pages itself has to be enabled with sourceBranch: gh-pages / (root)in Repo Settings → Pages. The 404 on/repos/.../pagessuggests this step is missing.If the workflow has not run on a tag yet, you can either retag (
git tag -f v2.6.3 && git push --force origin v2.6.3) to retrigger, or invoke the workflow manually if it acceptsworkflow_dispatch.Manual one-shot alternative (if you don't want to wait for CI)
After that,
helm repo add comqtt https://wind-c.github.io/comqtt && helm repo updateshould work.Happy to send a PR tightening the README to either (a) hide the
helm repo addline until the chart is actually published, or (b) replace it with ahelm install oci://...line using the GHCR-published chart (chart-releaser-action also supports OCI distribution). Whichever you prefer, just let me know.Thanks!