Helm Docs #1
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
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@d632683dd7b4114ad314bca15554477dd762a938 # tag=v4.2.0 | |
- name: Setup Go | |
uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # tag=v5.0.2 | |
with: | |
go-version: "1.22" | |
check-latest: true | |
- name: Install helm-docs | |
run: go install -v github.com/norwoodj/helm-docs/cmd/[email protected] | |
- name: Run helm-docs | |
run: helm-docs | |
- name: Create Pull Request | |
uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f # tag=v7.0.5 | |
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 |