Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions .github/workflows/helm-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: helm-docs

on:
push:
branches:
- main

jobs:
helm-docs:
runs-on: ubuntu-latest
permissions:
contents: write

steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
with:
ref: ${{ github.head_ref || github.ref_name }}
persist-credentials: true

- name: Install helm-docs
run: |
HELM_DOCS_VERSION=$(curl -sSL https://api.github.com/repos/norwoodj/helm-docs/releases/latest | grep '"tag_name"' | sed 's/.*"v\([^"]*\)".*/\1/')
echo "Installing helm-docs v${HELM_DOCS_VERSION}"
curl -sSL "https://github.com/norwoodj/helm-docs/releases/download/v${HELM_DOCS_VERSION}/helm-docs_${HELM_DOCS_VERSION}_Linux_x86_64.tar.gz" \
| tar -xz helm-docs
sudo mv helm-docs /usr/local/bin/helm-docs
helm-docs --version

- name: Run helm-docs
run: helm-docs

- name: Commit updated README
run: |
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git add README.md
if git diff --cached --quiet; then
echo "No changes to commit."
else
git commit -m "docs: update helm chart README via helm-docs [skip ci]"
git push
fi
Loading