MG-143 - Auto-generate Markdown documentation from Helm charts (#144) #18
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
| # Copyright (c) Magistrala | |
| # SPDX-License-Identifier: Apache-2.0 | |
| name: Generate Helm Docs | |
| on: | |
| push: | |
| branches: | |
| - master | |
| jobs: | |
| generate-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: ${{ github.repository }} | |
| ref: ${{ github.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 |