Skip to content

Latest commit

 

History

History
194 lines (140 loc) · 11.3 KB

File metadata and controls

194 lines (140 loc) · 11.3 KB

Icon GitHub Action: Release Helm Chart

Release Helm Chart

Marketplace Release License Stars PRs Welcome

Overview

Action to release a Helm chart to OCI registry. Supports umbrella charts: if a chart has local dependencies having version 0.0.0, the action will update those dependencies version with the given tag, then update the Chart.lock accordingly.

Permissions

This action requires the following permissions on the repository:

  • contents: read: to read the chart files
  • packages: write: to publish the chart to the OCI registry (required for GitHub Package registry only)

Usage

- uses: hoverkraft-tech/ci-github-container/actions/helm/release-chart@e4bf7a12228a2a4b5993d2d36b99b4dd0ec80bf5 # 0.32.1
  with:
    # OCI registry where to push chart.
    # See https://github.com/appany/helm-oci-chart-releaser#usage.
    #
    # This input is required.
    # Default: `ghcr.io`
    oci-registry: ghcr.io

    # OCI registry username.
    # See https://github.com/appany/helm-oci-chart-releaser#usage.
    #
    # This input is required.
    # Default: `${{ github.repository_owner }}`
    oci-registry-username: ${{ github.repository_owner }}

    # OCI registry password.
    # See https://github.com/appany/helm-oci-chart-releaser#usage.
    #
    # This input is required.
    # Default: `${{ github.token }}`
    oci-registry-password: ${{ github.token }}

    # Chart name to release
    # This input is required.
    chart: ""

    # Path to the chart to release
    # This input is required.
    path: ""

    # Define charts values to be filled.
    # See https://mikefarah.gitbook.io/yq/.
    # Format: `[{ file, path, value }]`.
    #
    # Example:
    #
    # ```json
    # [
    # {
    # "file": "charts/application/charts/api/values.yaml",
    # "path": ".image.registry", "value": "ghcr.io"
    # }
    # ]
    # ```
    values: ""

    # List of Helm repositories to add before release charts.
    # See https://helm.sh/docs/helm/helm_repo_add/.
    helm-repositories: ""

    # The release tag to set to chart
    # This input is required.
    tag: ""

    # List of YAML paths to update with the tag.
    # Comma separated list of paths.
    #
    # Default: `.version,.appVersion`
    update-tag-paths: .version,.appVersion

Inputs

Input Description Required Default
oci-registry OCI registry where to push chart. true ghcr.io
See https://github.com/appany/helm-oci-chart-releaser#usage.
oci-registry-username OCI registry username. true ${{ github.repository_owner }}
See https://github.com/appany/helm-oci-chart-releaser#usage.
oci-registry-password OCI registry password. true ${{ github.token }}
See https://github.com/appany/helm-oci-chart-releaser#usage.
chart Chart name to release true -
path Path to the chart to release true -
values Define charts values to be filled. false -
See https://mikefarah.gitbook.io/yq/.
Format: [{ file, path, value }].
Example:
[
 {
 "file": "charts/application/charts/api/values.yaml",
 "path": ".image.registry", "value": "ghcr.io"
 }
]
helm-repositories List of Helm repositories to add before release charts. false -
See https://helm.sh/docs/helm/helm_repo_add/.
tag The release tag to set to chart true -
update-tag-paths List of YAML paths to update with the tag. false .version,.appVersion
Comma separated list of paths.

Outputs

Output Description
image Chart image (Format: {registry}/{repository}/{image}:{tag}).
See https://github.com/appany/helm-oci-chart-releaser.

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

License

This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2026 hoverkraft

For more details, see the license.


This documentation was automatically generated by CI Dokumentor.