Skip to content
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

Add helm-docs generation and linting #5

Draft
wants to merge 1 commit into
base: devel
Choose a base branch
from
Draft

Add helm-docs generation and linting #5

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
22 changes: 22 additions & 0 deletions .github/workflows/linting.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,28 @@ jobs:
- name: Run gitlint
run: make gitlint

helm-docs:
name: Helm Docs Generation
runs-on: ubuntu-latest
steps:
- name: Check out the repository
uses: actions/checkout@v2

- name: Run helm-docs
run: |
HELM_DOCS_VERSION="0.15.0"
# Avoid polluting repo with helm-docs' README/LICENSE or other files in the release archive
cd /tmp
curl -sL "https://github.com/norwoodj/helm-docs/releases/download/v${HELM_DOCS_VERSION}/helm-docs_${HELM_DOCS_VERSION}_Linux_x86_64.tar.gz" | tar zx
cd -
/tmp/helm-docs
if [[ ! -z "$(git status --porcelain)" ]]; then
echo "Helm docs not up-to-date:"
git status --porcelain
echo "Run helm-docs, as the CI does above, and commit the updated docs."
exit 1
fi

markdown-link-check:
name: Markdown Links (modified files)
runs-on: ubuntu-latest
Expand Down