Skip to content

Commit

Permalink
ci: add github action to check if helm docs is updated
Browse files Browse the repository at this point in the history
  • Loading branch information
sbaizet-ledger committed Aug 29, 2024
1 parent e65afe6 commit 17d81bb
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 1 deletion.
43 changes: 43 additions & 0 deletions .github/workflows/helm-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Check Helm Docs

on:
pull_request:
paths:
- 'charts/**' # Only trigger on changes to charts

jobs:
check-helm-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3

- name: Set up Go environment
uses: actions/setup-go@v4
with:
go-version: '1.23' # Ensure you have a suitable Go version

- name: Install helm-docs
run: |
go install github.com/norwoodj/helm-docs/cmd/helm-docs@latest
- name: Run helm-docs
run: |
helm-docs
- name: Check for uncommitted changes
run: |
git diff --exit-code
continue-on-error: true
id: git_diff

- name: Fail if helm-docs changes were needed
if: steps.git_diff.outcome == 'failure'
run: |
echo "::error::helm-docs was not applied or is outdated"
exit 1
- name: Success message
if: steps.git_diff.outcome == 'success'
run: |
echo "helm-docs is up-to-date"
2 changes: 1 addition & 1 deletion charts/balance-checker/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
apiVersion: v2
description: balance-checker helm charts
name: balance-checker
version: 0.0.1
version: 0.0.3
appVersion: v0.1.0
kubeVersion: ">=1.22.0-0"
maintainers:
Expand Down

0 comments on commit 17d81bb

Please sign in to comment.