Skip to content

chore: add Artifact Hub repository metadata - #325

Open
jordan-simonovski wants to merge 1 commit into
gh-pagesfrom
jordansimonovski/artifacthub-metadata
Open

jordan-simonovski wants to merge 1 commit into
gh-pagesfrom
jordansimonovski/artifacthub-metadata

Conversation

@jordan-simonovski

Copy link
Copy Markdown
Contributor

Gives the clickstack listing on Artifact Hub the verified publisher badge and lists artifacthub-admin@clickhouse.com as its owner.

  • Artifact Hub reads artifacthub-repo.yml from next to index.yaml, so this targets gh-pages, which GitHub Pages serves from its root.
  • chart-releaser only rewrites index.yaml, so the file survives releases.

Breaking changes: none.

@changeset-bot

changeset-bot Bot commented Nov 18, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: fee0969

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions

Copy link
Copy Markdown
Contributor

Deep Review

✅ No critical issues found.

This PR adds a single 5-line artifacthub-repo.yml. The central correctness question — whether the file lands where Artifact Hub actually reads it — checks out: the PR base (136044a) is the gh-pages branch tip, so the file is committed to the gh-pages root directly beside the served index.yaml at https://clickhouse.github.io/ClickStack-helm-charts/. The YAML is valid and the keys (repositoryID, owners[].name, owners[].email) match the Artifact Hub schema. chart-releaser-action only rewrites index.yaml, so the file survives routine releases. No P0/P1 issues.

🟡 P2 -- recommended

  • artifacthub-repo.yml:2 -- The repositoryID UUID and owner email are unverifiable from the diff; if either does not match the repository and user account registered on Artifact Hub, the verified-publisher badge and ownership claim silently never apply and nothing in the repo surfaces an error, defeating the PR's stated goal.
    • Fix: Confirm 64bbac14-0c92-49bb-baf3-e8fdf38ec8fc is the UUID Artifact Hub assigned to the clickstack listing and that artifacthub-admin@clickhouse.com is a registered Artifact Hub account before relying on the badge.
  • artifacthub-repo.yml:1 -- The file lives only on the generated gh-pages branch with no copy under source control on main and no workflow step to recreate it, so anyone working from main cannot see how ownership verification is configured and the file leaves no trace if gh-pages is ever rebuilt from scratch.
    • Fix: Keep a source-of-truth copy on main and add a publish step that places it on gh-pages, so the metadata is discoverable and reproducible independent of manual commits.
🔵 P3 nitpicks (1)
  • artifacthub-repo.yml:2 -- No CI validation guards this file, so a future key typo (e.g. repositoryId for repositoryID, or owner for owners) would silently disable the badge with no build failure.
    • Fix: Add a lightweight YAML/schema check for artifacthub-repo.yml to CI.

Reviewers (4): correctness, project-standards, maintainability, previous-comments.

Testing gaps:

  • No automated check asserts artifacthub-repo.yml remains present at the gh-pages served root after future chart-releaser runs.
  • No CI lint validates the file's YAML validity or Artifact Hub schema key names.

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.

This branch has not been deployed

No deployments
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