charts: publish helm chart on Artifact Hub - #1563
Conversation
The chart is published to quay.io since v0.87.0, but the generated release notes only describe the manifest based installation. Add the helm command next to it, and note that the chart also creates the NMState custom resource, so it is a single step. Assisted-By: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Enrique Llorente <ellorent@redhat.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Pull request overview
Adds Helm installation guidance to generated release notes.
Changes:
- Documents OCI-based Helm installation.
- Explains default
NMStateresource creation. - Retains manifest installation as an alternative.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The chart is published to quay.io as an OCI artifact, but it is not listed on Artifact Hub, where users look for charts. Registering the repository there is a manual step, these are the pieces the repository has to provide. Artifact Hub renders the chart README as the package page, and the chart did not ship one, so the page would be empty. The repository metadata file carries the ownership information, it is pushed to the chart repository under the artifacthub.io tag. Assisted-By: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Enrique Llorente <ellorent@redhat.com>
The repository has been added to Artifact Hub, so the identifier is known now. It enables the "Verified publisher" flag, and the metadata file has already been pushed to the chart repository under the artifacthub.io tag. Assisted-By: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Enrique Llorente <ellorent@redhat.com>
03365e6 to
ddef57b
Compare
The listing shows no license, because Artifact Hub takes it from a LICENSE file inside the chart package or from the annotation, and the chart ships neither. Add the annotation and a couple of documentation links. Assisted-By: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Enrique Llorente <ellorent@redhat.com>
The Artifact Hub repository metadata file was not referenced anywhere, so there was nothing telling a reader that it exists, what it is for or how it reaches the registry. Describe it in the developer guide, next to the rest of the chart publishing. Assisted-By: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Enrique Llorente <ellorent@redhat.com>
|
@qinqon: The following test failed, say
DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
Is this a BUG FIX or a FEATURE?:
/kind enhancement
What this PR does / why we need it:
The chart is published to
quay.io/nmstate/kubernetes-nmstatesince v0.87.0, but nothing tells users about it and the chart is not discoverable. This adds the missing pieces:Helm instructions in the release notes (
hack/release-notes.tmpl). The generated notes only documented the manifest based installation. Rendered output:The helm path does not need the separate
NMStateCR step, since the chart creates it by default (nmstate.enabled=true).A chart README (
charts/kubernetes-nmstate/README.md). Artifact Hub renders the chart README as the package page body, and the chart did not ship one, so the page would be empty. It covers install, values, usage, upgrade and uninstall.Artifact Hub repository metadata (
hack/artifacthub-repo.yml), carrying the ownership information.Special notes for your reviewer:
Listing the chart on Artifact Hub is a manual step that still has to be done: sign in at artifacthub.io, create an
nmstateorganization and add a repository of kind Helm charts with the urloci://quay.io/nmstate/kubernetes-nmstate. From then on new chart versions are indexed automatically. This PR only provides what the repository side has to contribute.Two consequences worth knowing:
repositoryIDinhack/artifacthub-repo.ymlis empty on purpose, the value only exists once the repository has been added. Filling it in later enables theVerified publisherflag. Theownerssection alone is enough for the ownership claim.0.87.0is already published without it.The metadata file is pushed by hand with
oras(the command is in the file header). It changes rarely, so no release automation was added for it, and the chart push itself is unchanged.For reference, MetalLB is set up the same way: registered manually,
artifacthub-repo.ymlwithrepositoryIDplusowners, chart README, and noartifacthub.io/*annotations, which is why none were added here.Verified with
make lint-helmandmake whitespace-check, and by packaging the chart to confirmREADME.mdends up inside the tarball. The rendered release notes were checked against the v0.87.0 ones produced by CI: same changelog body, only the Installation section differs.Release note: