Skip to content

MG-143 - auto-generate Markdown documentation from Helm charts #3

MG-143 - auto-generate Markdown documentation from Helm charts

MG-143 - auto-generate Markdown documentation from Helm charts #3

Workflow file for this run

# Copyright (c) Magistrala
# SPDX-License-Identifier: Apache-2.0
name: Generate Helm Docs
on:
pull_request:
jobs:
generate-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.ref }}
- 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: true
git-push-user-name: "github-actions[bot]"
git-push-user-email: "github-actions[bot]@users.noreply.github.com"
git-commit-message: "Auto-generate Helm chart documentation"
fail-on-diff: true