This repository has been archived by the owner on Dec 21, 2023. It is now read-only.
Update README.md #3939
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: Validate Helm Docs | |
| on: | |
| pull_request: | |
| branches: | |
| - 'master' | |
| - '[0-9]+.[1-9][0-9]*.x' | |
| defaults: | |
| run: | |
| shell: bash | |
| jobs: | |
| check-helm-docs: | |
| name: Check helm documentation values | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v4 | |
| - name: Set up Node | |
| uses: actions/setup-node@v3.8.2 | |
| with: | |
| node-version: 16 | |
| - name: Install readme generator | |
| run: | | |
| git clone https://github.com/bitnami-labs/readme-generator-for-helm.git | |
| cd ./readme-generator-for-helm | |
| npm ci | |
| npm install --location=global ./ | |
| cd .. | |
| - name: Execute diff | |
| run: | | |
| cd ./installer/manifests/keptn | |
| cp ./README.md ./README-old.md | |
| readme-generator --values=./values.yaml --readme=./README.md | |
| if ! cmp --quiet ./README-old.md ./README.md; then | |
| echo "The Helm values have changes that are not reflected in the readme. Please use ./gh-actions-scripts/generate-helm-docs.sh to re-generate the docs." | |
| echo "" | |
| echo "=========== Diff ===========" | |
| diff ./README-old.md ./README.md | |
| exit 1 | |
| else | |
| echo "" | |
| echo "Helm values documentation is correct!" | |
| fi |