Skip to content

build: Add 'chart-docs' make target #727

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

Merged
merged 1 commit into from
Jun 19, 2024
Merged

build: Add 'chart-docs' make target #727

Show file tree
Hide file tree
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
14 changes: 6 additions & 8 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ repos:
language: system
files: "(.*\\.go|go.mod|go.sum|go.mk)$"
pass_filenames: false
- id: chart-docs
name: chart-docs
entry: make chart-docs
language: system
files: "^charts/"
pass_filenames: false
- id: hugo-mod-tidy
name: hugo-mod-tidy
entry: bash -c "cd docs && hugo mod tidy"
Expand Down Expand Up @@ -145,11 +151,3 @@ repos:
- --comment-style
- <!--|| -->
- --allow-past-years
- repo: https://github.com/norwoodj/helm-docs
rev: v1.13.1
hooks:
- id: helm-docs
stages: [commit]
args:
# Make the tool search for charts only under the `example-charts` directory
- --chart-search-root=charts
5 changes: 5 additions & 0 deletions make/helm.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Copyright 2023 Nutanix. All rights reserved.
# SPDX-License-Identifier: Apache-2.0

.PHONY: chart-docs
chart-docs: ## Update helm chart docs
chart-docs:
helm-docs --chart-search-root=charts

.PHONY: lint-chart
lint-chart: ## Lints helm chart
lint-chart:
Expand Down
Loading