Skip to content

Latest commit

 

History

History
65 lines (56 loc) · 2.02 KB

README.md

File metadata and controls

65 lines (56 loc) · 2.02 KB

Helm Push

Build GitHub last commit License PRs Welcome

Push a chart to a ChartMuseum or OCI compatible registry with Helm v3

Usage

Using Token Auth with OCI Registry:

steps:
  - name: Push Helm chart to OCI compatible registry (Github)
    uses: bsord/helm-push@v4
    with:
      useOCIRegistry: true
      registry-url:  https://ghcr.io/${{ github.repository }}
      username: bsord
      access-token: ${{ secrets.REGISTRY_ACCESS_TOKEN }}
      force: true
      chart-folder: chart

Using Password Auth:

steps:
  - name: Push Helm Chart to ChartMuseum
    uses: bsord/helm-push@v4
    with:
      username: ${{ secrets.HELM_USERNAME }}
      password: ${{ secrets.HELM_PASSWORD }}
      registry-url: 'https://h.cfcr.io/user_or_org/reponame'
      force: true
      chart-folder: chart

Using Token Auth:

steps:
  - name: Push Helm Chart to ChartMuseum
    uses: bsord/helm-push@v4
    with:
      access-token: ${{ secrets.HELM_API_KEY }}
      registry-url: 'https://h.cfcr.io/user_or_org/reponame'
      force: true
      chart-folder: chart

Parameters

Key Value Required Default
useOCIRegistry Push to OCI compatibly registry No false
access-token API Token with Helm read/write permissions Yes (if using token auth) ""
username Username for registry Yes (if using pw auth) ""
password Password for registry Yes (if using pw auth) ""
registry-url Registry url Yes ""
chart-folder Relative path to chart folder to be published No chart
force Force overwrite if version already exists No false

License

This project is distributed under the MIT license.

TODO