-
Notifications
You must be signed in to change notification settings - Fork 18
Consider consolidating Helm chart distribution to OCI-only (drop GitHub Pages) #326
Copy link
Copy link
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Summary
Simplify the Helm chart release pipeline by consolidating distribution to OCI-only and dropping the GitHub Pages-based Helm repository.
Current State
The release workflow (release_images.yml) publishes the Helm chart to two distribution channels:
- OCI registry (GHCR) via
helm push ... oci://ghcr.io/documentdb/... - GitHub Pages via the
repair_helm_pages_release.ymlreusable workflow (publishes to thegh-pagesbranch withindex.yaml)
Problem
Maintaining two distribution channels adds complexity:
repair_helm_pages_release.ymlis a 300+ line workflow dedicated to rebuilding/mergingindex.yamland publishing togh-pages- The
gh-pagesbranch must be maintained alongside the OCI registry - Any issues with
index.yamlrequire manual repair workflows - OCI is the modern standard for Helm chart distribution (supported since Helm 3.8, which is 3+ years old)
Proposal
- Drop the GitHub Pages-based Helm repository and consolidate to OCI-only distribution
- Remove
repair_helm_pages_release.ymland thepublish-helm-pagesjob fromrelease_images.yml - Update documentation (README, install guides) to use OCI-based install commands exclusively:
helm install documentdb oci://ghcr.io/documentdb/documentdb-operator --version <version>
Tradeoff
- Users lose
helm repo add+helm search repodiscoverability (must know the OCI URL) - Requires Helm 3.8+ (released March 2022, widely adopted)
- Significantly simplifies the release pipeline
Note
The OCI URL and install command should be prominently documented in the README to compensate for the loss of helm search discoverability.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request