-
Notifications
You must be signed in to change notification settings - Fork 551
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Automatically generating markdown documentation for helm charts…
… with helm-docs (#1496)
- Loading branch information
1 parent
39b6eac
commit 4d1a037
Showing
4 changed files
with
459 additions
and
157 deletions.
There are no files selected for viewing
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
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 |
Oops, something went wrong.