helm-docs.yaml

name: Check Helm Docs

on:
  pull_request:
    paths:
      - 'charts/**'   # Only trigger on changes to charts

jobs:
  check-helm-docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Set up Go environment
        uses: actions/setup-go@v4
        with:
          go-version: '1.23'  # Ensure you have a suitable Go version

      - name: Install helm-docs
        run: |
          go install github.com/norwoodj/helm-docs/cmd/helm-docs@latest

      - name: Run helm-docs
        run: |
          helm-docs

      - name: Check for uncommitted changes
        run: |
          git diff --exit-code
        continue-on-error: true
        id: git_diff

      - name: Fail if helm-docs changes were needed
        if: steps.git_diff.outcome == 'failure'
        run: |
          echo "::error::helm-docs was not applied or is outdated"
          exit 1

      - name: Success message
        if: steps.git_diff.outcome == 'success'
        run: |
          echo "helm-docs is up-to-date"