Update Documentation #14
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: Update Documentation | |
on: | |
workflow_dispatch: | |
workflow_run: | |
workflows: | |
- "chart-publish" | |
types: | |
- completed | |
permissions: read-all | |
jobs: | |
documentation-update: | |
runs-on: ubuntu-latest | |
if: ${{github.event.workflow_run.conclusion == 'success'}} | |
env: | |
HELM_DOCS_VERSION: '1.12.0' | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Install helm-docs | |
run: | | |
cd /tmp | |
wget https://github.com/norwoodj/helm-docs/releases/download/v${{env.HELM_DOCS_VERSION}}/helm-docs_${{env.HELM_DOCS_VERSION}}_Linux_x86_64.tar.gz | |
tar -xvf helm-docs_${{env.HELM_DOCS_VERSION}}_Linux_x86_64.tar.gz | |
sudo mv helm-docs /usr/local/sbin | |
- name: Run helm-docs | |
run: | | |
helm-docs -t README.md.gotmpl -o README.md -b for-the-badge | |
- name: Commit changes | |
run: | | |
git config --local user.email "[email protected]" | |
git config --local user.name "GitHub Action" | |
git add charts/node-red/README.md | |
git commit -m "Update documentation via helm-docs" | |
git push |