From d9d0d8e1d37cdb339aa8f3998d660d418ab83bcb Mon Sep 17 00:00:00 2001 From: Michael Adam Date: Wed, 28 Aug 2024 10:00:25 +0200 Subject: [PATCH] ci: rename 'check-helm-docs' to 'check.helm-docs This makes the naming of ci-related make targets more systematic and consistent. It is based on PR https://github.com/rook/rook/pull/14672 and continues the pattern started in that PR. Signed-off-by: Michael Adam --- .github/workflows/docs-check.yml | 2 +- Makefile | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml index 1a13e842d..c110b2b7d 100644 --- a/.github/workflows/docs-check.yml +++ b/.github/workflows/docs-check.yml @@ -43,7 +43,7 @@ jobs: !Documentation/Helm-Charts - name: Check helm-docs - run: make check-helm-docs + run: make check.helm-docs - name: Check docs run: make check.docs - name: Install mkdocs and dependencies diff --git a/Makefile b/Makefile index 825664cf7..6fef6948b 100644 --- a/Makefile +++ b/Makefile @@ -201,7 +201,7 @@ helm-docs: $(HELM_DOCS) ## Use helm-docs to generate documentation from helm cha -t ../../../Documentation/Helm-Charts/ceph-cluster-chart.gotmpl.md \ -t ../../../Documentation/Helm-Charts/_templates.gotmpl -check-helm-docs: +check.helm-docs: @$(MAKE) helm-docs @git diff --exit-code || { \ echo "Please run 'make helm-docs' locally, commit the updated docs, and push the change. See https://rook.io/docs/rook/latest/Contributing/documentation/#making-docs" ; \