Merge pull request #20 from Wikodit/fix/wik-webservice-hpa-replicas #34
This file contains hidden or 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: Generate Documentation | |
| on: | |
| pull_request: | |
| paths: | |
| - 'charts/**/values.yaml' | |
| - 'charts/**/Chart.yaml' | |
| - 'charts/**/README.md.gotmpl' | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'charts/**/values.yaml' | |
| - 'charts/**/Chart.yaml' | |
| - 'charts/**/README.md.gotmpl' | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ github.head_ref }} | |
| fetch-depth: 0 | |
| - name: Install helm-docs | |
| run: | | |
| tmp="$(mktemp -d)" | |
| wget -q -O "$tmp/helm-docs.tar.gz" \ | |
| https://github.com/norwoodj/helm-docs/releases/download/v1.13.1/helm-docs_1.13.1_Linux_x86_64.tar.gz | |
| tar -xzf "$tmp/helm-docs.tar.gz" -C "$tmp" | |
| sudo mv "$tmp/helm-docs" /usr/local/bin/ | |
| - name: Run helm-docs | |
| run: helm-docs --chart-search-root=charts | |
| - name: Check for changes | |
| id: changes | |
| run: | | |
| if [[ -n "$(git status --porcelain)" ]]; then | |
| echo "changed=true" >> "$GITHUB_OUTPUT" | |
| fi | |
| - name: Commit changes (push to main) | |
| if: github.event_name == 'push' && steps.changes.outputs.changed == 'true' | |
| run: | | |
| git config user.name "github-actions[bot]" | |
| git config user.email "github-actions[bot]@users.noreply.github.com" | |
| git add -A | |
| git commit -m "docs: auto-generate chart documentation" | |
| git push | |
| - name: Comment on PR | |
| if: github.event_name == 'pull_request' && steps.changes.outputs.changed == 'true' | |
| uses: actions/github-script@v8 | |
| with: | |
| script: | | |
| github.rest.issues.createComment({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| issue_number: context.issue.number, | |
| body: '⚠️ **Documentation out of date**\n\nPlease run `helm-docs` locally or documentation will be auto-updated on merge.' | |
| }) |