forked from falcosecurity/charts
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Aldo Lacuku <aldo@lacuku.eu>
- Loading branch information
Showing
1 changed file
with
38 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,38 @@ | ||
name: Check Helm Docs | ||
|
||
on: | ||
pull_request: | ||
|
||
jobs: | ||
readme: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v2 | ||
|
||
- name: Set up Docker | ||
uses: docker/setup-docker@v2 | ||
|
||
- name: Run Helm Docs and check the outcome | ||
run: | | ||
for chart in event-generator falco k8s-metacollector; do | ||
docker run \ | ||
--rm \ | ||
--workdir=/helm-docs \ | ||
--volume "$(pwd):/helm-docs" \ | ||
-u $(id -u) \ | ||
jnorwood/helm-docs:v1.11.0 \ | ||
helm-docs -c ./charts/$chart -t ./README.gotmpl -o ./README.md | ||
done | ||
exit_code=$(git diff --exit-code) | ||
exit ${exit_code} | ||
- name: Print a comment in case of failure | ||
run: | | ||
echo "The README.md filer are not up to date. | ||
Please, run make docs before pushing." | ||
exit 1 | ||
if: | | ||
failure() && github.event.pull_request.head.repo.full_name == github.repository |