Awesome
chart-testing Action
A GitHub Action for installing the helm/chart-testing CLI tool.
Usage
Pre-requisites
- A GitHub repo containing a directory with your Helm charts (e.g:
charts
) - A workflow YAML file in your
.github/workflows
directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file
Inputs
For more information on inputs, see the API Documentation
version
: The chart-testing version to install (default:3.11.0
)yamllint_version
: Theyamllint
version to install (default:1.33.0
)yamale_version
: Theyamale
version to install (default:4.0.4
)
Example Workflow
Create a workflow (eg: .github/workflows/lint-test.yaml
):
Note that Helm and Python must be installed.
This can be achieved using actions as shown in the example below.
Python is required because ct lint
runs Yamale and yamllint which require Python.
name: Lint and Test Charts
on: pull_request
jobs:
lint-test:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up Helm
uses: azure/setup-helm@v4.2.0
with:
version: v3.14.4
- uses: actions/setup-python@v5
with:
python-version: '3.x'
check-latest: true
- name: Set up chart-testing
uses: helm/chart-testing-action@v2.7.0
- name: Run chart-testing (list-changed)
id: list-changed
run: |
changed=$(ct list-changed --target-branch ${{ github.event.repository.default_branch }})
if [[ -n "$changed" ]]; then
echo "changed=true" >> "$GITHUB_OUTPUT"
fi
- name: Run chart-testing (lint)
if: steps.list-changed.outputs.changed == 'true'
run: ct lint --target-branch ${{ github.event.repository.default_branch }}
- name: Create kind cluster
if: steps.list-changed.outputs.changed == 'true'
uses: helm/kind-action@v1.10.0
- name: Run chart-testing (install)
if: steps.list-changed.outputs.changed == 'true'
run: ct install --target-branch ${{ github.event.repository.default_branch }}
This uses helm/kind-action
GitHub Action to spin up a kind Kubernetes cluster,
and helm/chart-testing
to lint and test your charts on every pull request.
Upgrading from v1.x.x
v2.0.0 is a major release with breaking changes.
The action no longer wraps the chart-testing tool but simply installs it.
It is no longer run in a Docker container.
All ct
options are now directly available without the additional abstraction layer.
Code of conduct
Participation in the Helm community is governed by the Code of Conduct.