build: introduce a linting target name taxonomy

The linting targets used to mostly have ad-hoc names usually reflecting
the linting tool used (like shellcheck, yamllint, and checkmake).

This change systematizes the names of the linting targets to follow a
pattern of lint.foo where foo usually reflects *what* is linted rather
than *how*.

so, more idiomatically, the pattern can be described as "action.thing"
to indicacte that "action" is to be performed on a "thing".

This systematization is achieved by renaming a couple of targets:

- shellcheck -> lint.shell
- yamllint -> lint.yaml
- checkmake -> lint.make
0 helm.lint -> lint.helm
- pylint -> lint.python
fmt  -> lint.fmt

Additionally, a new target go.lint is introduced that runs
several go linting tools.

Finally, two fixing targets are renamed for consistency:

* fmt-fix -> fix.fmt
* markdownlint.fix -> fix/markdown

Signed-off-by: Michael Adam <obnox@samba.org>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Michael AdamandCopilot Autofix powered by AI committed 2026-04-29 17:27:18 +02:00
1 parent 05f1b00b81
commit 74c41f16cc
4 files changed
+29 -25

No files matched your search

+2 -2
View File
@@ -31,5 +31,5 @@ jobs:
fetch-depth: 0
- name: Run chart-testing (lint)
run: make helm.lint
- name: Lint the helm charts
run: make lint.helm
+3 -3
View File
@@ -28,7 +28,7 @@ jobs:
fetch-depth: 0
- name: Lint YAML files
run: make yamllint
run: make lint.yaml
pylint:
runs-on: ubuntu-latest
@@ -49,8 +49,8 @@ jobs:
pip install requests
pip install pygit2
- name: Lint Python files
run: make pylint
- name: Lint Python scripts
run: make lint.python
- name: Setup black for py
uses: psf/black@c6755bb741b6481d6b3d3bb563c83fa060db96c9 # stable
+2 -2
View File
@@ -25,5 +25,5 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- name: Run ShellCheck
run: make shellcheck
- name: Lint shell scripts
run: make lint.shell
+22 -18
View File
@@ -181,30 +181,34 @@ vet: ## Runs lint checks on go sources.
@$(MAKE) go.init
@$(MAKE) go.vet
.PHONY: fmt
fmt: $(YQ) ## Check formatting of go sources.
.PHONY: lint.fmt
lint.fmt: $(YQ) ## Check formatting of go sources.
@$(MAKE) go.fmt
fmt-fix: $(YQ) ## Reformatting of go sources.
fix.fmt: $(YQ) ## Reformatting of go sources.
@$(MAKE) go.fmt-fix
golangci-lint: $(YQ)
@$(MAKE) go.golangci-lint
.PHONY: markdownlint
markdownlint: ## Check formatting of documentation sources
.PHONY: lint.go
lint.go: lint.fmt vet golangci-lint ## run various go linters
.PHONY: lint.markdown
lint.markdown: ## Check formatting of documentation sources
@$(MARKDOWNLINT) "Documentation/**/**.md" "#Documentation/Helm-Charts/**" --config .markdownlint-cli2.cjs
.PHONY: markdownlint.fix
markdownlint.fix: ## Check and fix formatting of documentation sources
.PHONY: fix.markdown
fix.markdown: ## Check and fix formatting of documentation sources
@$(MARKDOWNLINT) "Documentation/**/**.md" "#Documentation/Helm-Charts/**" --fix --config .markdownlint-cli2.cjs
.PHONY: yamllint
yamllint:
.PHONY: lint.yaml
lint.yaml: ## lint yaml files
$(YAMLLINT) -c .yamllint deploy/examples/ --no-warnings
.PHONY: helm.lint
helm.lint: $(HELM) $(KUSTOMIZE) ## Check the helm charts
.PHONY: lint.helm
lint.helm: $(HELM) $(KUSTOMIZE) ## Check the helm charts
@ln -sf "$(notdir $(HELM))" "$(dir $(HELM))/helm"
PATH="$(dir $(HELM)):$$PATH" $(CT) lint --charts=./deploy/charts/rook-ceph,./deploy/charts/rook-ceph-cluster --validate-yaml=false --validate-maintainers=false --validate-chart-schema=false
$(HELM) -n rook-ceph template deploy/charts/rook-ceph > templated.yaml
@@ -214,18 +218,18 @@ helm.lint: $(HELM) $(KUSTOMIZE) ## Check the helm charts
rm templated.yaml kustomization.yaml
.PHONY: lint
lint: yamllint pylint shellcheck checkmake vet markdownlint golangci-lint helm.lint ## Run various linters
lint: lint.yaml lint.python lint.shell lint.make lint.go lint.markdown lint.helm ## Run various linters
.PHONY: pylint
pylint:
.PHONY: lint.python
lint.python: ## lint python scripts
pylint $(shell find $(ROOT_DIR) -name '*.py') -E
.PHONY: checkmake
checkmake:
.PHONY: lint.make
lint.make: ## lint the Makefile
@$(CHECKMAKE) Makefile
.PHONY: shellcheck
shellcheck: | $(SHELLCHECK)
.PHONY: lint.shell
lint.shell: | $(SHELLCHECK) ## lint shell scripts
$(SHELLCHECK) --severity=warning --format=gcc --shell=bash $(shell find $(ROOT_DIR) -type f -name '*.sh') build/reset build/sed-in-place
.PHONY: gen.codegen