Skip to content

add new helm-docs auto push action #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
OAharoni-RedHat wants to merge 1 commit into
base: main
Choose a base branch
from
+41 −0
Open

add new helm-docs auto push action #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .github/workflows/helm-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: helm-docs

on:
pull_request:
branches:
- main

permissions:
contents: read

jobs:
helm-docs:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
with:
persist-credentials: false

- name: Install helm-docs
run: |
HELM_DOCS_VERSION=$(curl -sSL https://api.github.com/repos/norwoodj/helm-docs/releases/latest | grep '"tag_name"' | sed 's/.*"v\([^"]*\)".*/\1/')
echo "Installing helm-docs v${HELM_DOCS_VERSION}"
curl -sSL "https://github.com/norwoodj/helm-docs/releases/download/v${HELM_DOCS_VERSION}/helm-docs_${HELM_DOCS_VERSION}_Linux_x86_64.tar.gz" \
| tar -xz helm-docs
sudo mv helm-docs /usr/local/bin/helm-docs
helm-docs --version

- name: Run helm-docs
run: helm-docs

- name: Check README is up to date
run: |
if ! git diff --quiet README.md; then
echo "README.md is out of date. Run helm-docs locally and commit the updated file."
echo ""
git diff README.md
exit 1
fi
echo "README.md is up to date."
Loading