feat: switch doc generation to use helm-docs and add a workflow to auto bump the chart version on pr approval #42
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Lint and Test Charts | |
# yamllint disable-line rule:truthy | |
on: | |
workflow_call: | |
workflow_dispatch: | |
pull_request: | |
paths: | |
- 'charts/**' | |
jobs: | |
lint-test: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Set up Helm | |
uses: azure/setup-helm@v3 | |
with: | |
version: v3.13.1 | |
- uses: gabe565/setup-helm-docs-action@v1 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: 3.x | |
check-latest: true | |
- name: Set up chart-testing | |
uses: helm/chart-testing-action@v2 | |
- name: Run chart-testing (list-changed) | |
id: list-changed | |
run: | | |
changed=$(ct list-changed --config .github/linters/ct.yaml) | |
if [[ -n "$changed" ]]; then | |
echo "changed=true" >> "$GITHUB_OUTPUT" | |
fi | |
- name: Run chart-testing (lint) | |
run: ct lint --config .github/linters/ct.yaml | |
- name: Create kind cluster | |
uses: helm/kind-action@v1 | |
if: steps.list-changed.outputs.changed == 'true' | |
- name: Run chart-testing (install) | |
run: ct install --config .github/linters/ct.yaml | |
- name: Check if the docs should be updates | |
shell: bash | |
run: | | |
helm-docs --chart-search-root charts --chart-to-generate charts/plex-media-server | |
if [ -n "$(git status --porcelain)" ]; then | |
echo "there are changes to the README" | |
exit -1 | |
fi |