helm_docs.yaml

name: Helm docs
on:
  push:
    branches:
    - 'master'
    paths:
     - 'chart/k8gb/**'
permissions:  # added using https://github.com/step-security/secure-workflows
  contents: read

jobs:
  build-helm-doc:
    permissions:
      contents: write  # for peter-evans/create-pull-request to create branch
      pull-requests: write  # for peter-evans/create-pull-request to create a PR
    name: Update Helm Doc
    runs-on: ubuntu-latest
    steps:
    - name: Harden Runner
      uses: step-security/harden-runner@6d3c2fe731c8f225990c8018cb71c337c0d9dfcd
      with:
        egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs

    - name: Checkout Code
      uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
    - name: Generate docs for helm chart - chart/k8gb/README.md
      uses: docker://jnorwood/helm-docs@sha256:717bd8f770bd1d25ccf79c876f1420e105832f2d6bbde12170405f58f540cb2d
      with:
        args: --template-files=_helm-docs-template.gotmpl
    - name: Create Pull Request
      uses: peter-evans/create-pull-request@67f9e1be23d8e8265191f0c42c877a5f28be83ae
      with:
        title: "Update Helm Docs"
        branch: ci-helm-doc
        delete-branch: true
        base: master
        signoff: true
        token: ${{ secrets.GITHUB_TOKEN }}