chart-releaser-action
by helm
A GitHub Action that automates turning a GitHub project into a self-hosted Helm chart repository using the helm/chart-releaser CLI tool.
A GitHub Action to turn a GitHub project into a self-hosted Helm chart repo, using helm/chart-releaser CLI tool
Primary Use Case
This tool is primarily used by DevOps and DevSecOps teams to automate the packaging, indexing, and publishing of Helm charts directly from a GitHub repository. It simplifies managing Helm chart repositories by integrating with GitHub Actions workflows, enabling continuous delivery of Kubernetes Helm charts in a self-hosted manner.
- Automates packaging, indexing, and publishing of Helm charts
- Supports custom charts directory configuration
- Integrates with GitHub Pages for hosting charts
- Allows skipping packaging or upload steps for advanced workflows
- Supports marking releases as latest or not
- Outputs released charts and chart versions for workflow use
- Uses GitHub token for secure publishing
- Configurable publishing branch (default: gh-pages)
Installation
- Ensure your GitHub repo contains a directory with Helm charts (default is /charts)
- Create a GitHub branch named gh-pages to store published charts
- In GitHub repo Settings under Pages, set the source branch to gh-pages
- Create a workflow YAML file in .github/workflows directory
- Add the chart-releaser-action step in the workflow referencing the desired version
- Set the CR_TOKEN environment variable to your GitHub token (e.g., ${{ secrets.GITHUB_TOKEN }})
Usage
>_ uses: helm/[email protected]Runs the chart-releaser GitHub Action at version v1.7.0 to package, index, and publish Helm charts.
>_ env:
CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"Sets the required GitHub token environment variable for authentication and publishing.
>_ skip_packaging: trueInput option to skip the packaging step, allowing custom packaging before the action runs.
>_ skip_upload: trueInput option to skip the upload step, useful for advanced uploading methods like OCI repositories.
>_ charts_dir: custom-chartsInput to specify a custom directory containing Helm charts instead of the default /charts.
- Integrate this tool into CI/CD pipelines to automate secure Helm chart releases, reducing human error and improving deployment security.
- Use the tool's ability to skip packaging or upload steps to incorporate advanced custom security scanning or signing workflows.
- Combine with container scanning tools to ensure Helm charts reference only trusted container images before publishing.
- Leverage the GitHub token for fine-grained access control and audit trail of Helm chart publishing activities.
- Employ this tool in purple team exercises to simulate attacker attempts to tamper with Helm charts and test detection and prevention controls.
Docs Take 2 Hours. AI Takes 10 Seconds.
Ask anything about chart-releaser-action. Installation? Config? Troubleshooting? Get answers trained on real docs and GitHub issues—not generic ChatGPT fluff.
This tool hasn't been indexed yet. Request indexing to enable AI chat.
Admin will review your request within 24 hours
Related Tools
earthly
earthly/earthly
Super simple build framework with fast, repeatable builds and an instantly familiar syntax – like Dockerfile and Makefile had a baby.
pull
wei/pull
🤖 Keep your forks up-to-date via automated PRs
jx
jenkins-x/jx
Jenkins X provides automated CI+CD for Kubernetes with Preview Environments on Pull Requests using Cloud Native pipelines from Tekton
zizmor
zizmorcore/zizmor
Static analysis for GitHub Actions
garden
garden-io/garden
Automation for Kubernetes development and testing. Spin up production-like environments for development, testing, and CI on demand. Use the same configuration and workflows at every step of the process. Speed up your builds and test runs via shared result caching
okteto
okteto/okteto
Develop your applications directly in your Kubernetes Cluster