Skip to content

Commit

Permalink
feat: Automatically generating markdown documentation for helm charts…
Browse files Browse the repository at this point in the history
… with helm-docs (#1496)
  • Loading branch information
littlejiancc authored Nov 11, 2024
1 parent 39b6eac commit 4d1a037
Show file tree
Hide file tree
Showing 4 changed files with 459 additions and 157 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/helm-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: "Helm Docs"

on:
pull_request:
branches:
- "*"

push:

jobs:

helm:
name: Helm Docs
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 1

- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: '1.22.9'

- name: Run helm-docs
run: |
GOBIN=$PWD GO111MODULE=on go install github.com/norwoodj/helm-docs/cmd/[email protected]
./helm-docs -c ${GITHUB_WORKSPACE}/helm/higress -f ../core/values.yaml
DIFF=$(git diff ${GITHUB_WORKSPACE}/helm/higress/*md)
if [ ! -z "$DIFF" ]; then
echo "Please use helm-docs in your clone, of your fork, of the project, and commit a updated README.md for the chart."
fi
git diff --exit-code
rm -f ./helm-docs
Loading

0 comments on commit 4d1a037

Please sign in to comment.