helm-docs.yml

name: Helm Docs

on:
  push:
    branches:
    - main
    paths:
    - .github/workflows/**
    - charts/**
  workflow_dispatch: { }

permissions: { }

jobs:
  update-docs:
    name: Update Docs
    runs-on: ubuntu-latest
    timeout-minutes: 5
    permissions:
      contents: write
      pull-requests: write
    steps:
    - name: Checkout Repository
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # tag=v6.0.2
    - name: Setup Go
      uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5 # tag=v6.2.0
      with:
        go-version: "1.22"
        check-latest: true
    - name: Install helm-docs
      run: go install -v github.com/norwoodj/helm-docs/cmd/helm-docs@v1.13.1
    - name: Run helm-docs
      run: helm-docs
    - name: Create Pull Request
      uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0 # tag=v8.1.0
      with:
        add-paths: "charts/*/README.md"
        branch: update-helm-docs
        body: "Updates Helm chart documentation using [helm-docs](https://github.com/norwoodj/helm-docs)"
        commit-message: Update helm docs
        delete-branch: true
        labels: documentation
        signoff: true
        title: Update helm docs