Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/helm/chart-testing-action
A GitHub Action to lint and test Helm charts
https://github.com/helm/chart-testing-action
actions chart-testing charts ci-cd github-actions helm kubernetes lint
Last synced: about 12 hours ago
JSON representation
A GitHub Action to lint and test Helm charts
- Host: GitHub
- URL: https://github.com/helm/chart-testing-action
- Owner: helm
- License: apache-2.0
- Created: 2019-11-22T15:47:43.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T01:11:44.000Z (26 days ago)
- Last Synced: 2024-10-29T15:47:49.652Z (22 days ago)
- Topics: actions, chart-testing, charts, ci-cd, github-actions, helm, kubernetes, lint
- Language: Shell
- Homepage: https://github.com/helm/chart-testing
- Size: 94.7 KB
- Stars: 250
- Watchers: 8
- Forks: 71
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# *chart-testing* Action
A GitHub Action for installing the [helm/chart-testing](https://github.com/helm/chart-testing) CLI tool.
## Usage
### Pre-requisites
1. A GitHub repo containing a directory with your Helm charts (e.g: `charts`)
1. A workflow YAML file in your `.github/workflows` directory.
An [example workflow](#example-workflow) is available below.
For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file)
### Inputs
For more information on inputs, see the [API Documentation](https://developer.github.com/v3/repos/releases/#input)
- `version`: The chart-testing version to install (default: `3.11.0`)
- `yamllint_version`: The `yamllint` version to install (default: `1.33.0`)
- `yamale_version`: The `yamale` 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](https://github.com/23andMe/Yamale) and [yamllint](https://github.com/adrienverge/yamllint) which require Python.
```yaml
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/[email protected]
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/[email protected]
- 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/[email protected]
- 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`](https://www.github.com/helm/kind-action) GitHub Action to spin up a [kind](https://kind.sigs.k8s.io/) Kubernetes cluster,
and [`helm/chart-testing`](https://www.github.com/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](CODE_OF_CONDUCT.md).