MG-143 - auto-generate Markdown documentation from Helm charts #12
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: Generate Helm Docs | |
| on: | |
| pull_request: | |
| branches: | |
| - '*' # Run on all pull requests | |
| jobs: | |
| generate-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: ${{ github.event.pull_request.head.repo.full_name }} | |
| ref: ${{ github.event.pull_request.head.ref }} | |
| fetch-depth: 0 | |
| - name: Generate Helm Docs | |
| uses: losisin/[email protected] | |
| with: | |
| chart-search-root: "charts/magistrala" | |
| values-file: "values.yaml" | |
| output-file: "README.md" | |
| template-files: "README.md.gotmpl" | |
| git-push: false | |
| fail-on-diff: true | |
| # Show the output of the README.md file after it's generated | |
| - name: Show README.md content | |
| run: cat charts/magistrala/README.md | |
| # Show the diff between the current README and the generated one (if fail-on-diff: true fails) | |
| - name: Show README diff | |
| run: git diff charts/magistrala/README.md |