forked from stakewise/helm-charts
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CI check for documentation update
- Loading branch information
Showing
1 changed file
with
28 additions
and
0 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,28 @@ | ||
name: Helm Docs Check | ||
|
||
on: | ||
pull_request | ||
|
||
jobs: | ||
helm-docs-validation: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v3 | ||
|
||
- name: Set up Docker | ||
uses: docker/setup-buildx-action@v2 | ||
|
||
- name: Run helm-docs to update docs | ||
run: | | ||
docker run --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest | ||
- name: Check for unstaged changes | ||
run: | | ||
if [ -n "$(git status --porcelain)" ]; then | ||
echo "Unstaged changes detected. Please update the Helm chart documentation in your PR." | ||
exit 1 | ||
else | ||
echo "No unstaged changes detected. Documentation is up-to-date." | ||
fi |