# Copyright 2023 The cert-manager Authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. .PHONY: ci-presubmit ## Run all checks (but not Go tests) which should pass before any given pull ## request or change is merged. ## ## @category CI ci-presubmit: verify-imports verify-errexit verify-boilerplate verify-codegen verify-crds verify-modules verify-helm-docs .PHONY: verify-golangci-lint verify-golangci-lint: | $(NEEDS_GOLANGCI-LINT) find . -name go.mod -not \( -path "./$(bin_dir)/*" -prune \) -execdir $(GOLANGCI-LINT) run --timeout=30m --config=$(CURDIR)/.golangci.ci.yaml \; .PHONY: verify-modules verify-modules: | $(NEEDS_CMREL) $(CMREL) validate-gomod --path $(shell pwd) --no-dummy-modules github.com/cert-manager/cert-manager/integration-tests .PHONY: verify-imports verify-imports: | $(NEEDS_GOIMPORTS) ./hack/verify-goimports.sh $(GOIMPORTS) .PHONY: verify-chart verify-chart: $(bin_dir)/cert-manager-$(RELEASE_VERSION).tgz DOCKER=$(CTR) ./hack/verify-chart-version.sh $< .PHONY: verify-errexit verify-errexit: ./hack/verify-errexit.sh .PHONY: verify-boilerplate verify-boilerplate: | $(NEEDS_BOILERSUITE) $(BOILERSUITE) . .PHONY: verify-licenses ## Check that the LICENSES file is up to date; must pass before a change to go.mod can be merged ## ## @category CI verify-licenses: $(bin_dir)/scratch/LATEST-LICENSES $(bin_dir)/scratch/LATEST-LICENSES-acmesolver $(bin_dir)/scratch/LATEST-LICENSES-cainjector $(bin_dir)/scratch/LATEST-LICENSES-controller $(bin_dir)/scratch/LATEST-LICENSES-startupapicheck $(bin_dir)/scratch/LATEST-LICENSES-webhook $(bin_dir)/scratch/LATEST-LICENSES-integration-tests $(bin_dir)/scratch/LATEST-LICENSES-e2e-tests @diff $(bin_dir)/scratch/LATEST-LICENSES LICENSES >/dev/null || (echo -e "\033[0;33mLICENSES seems to be out of date; update with 'make update-licenses'\033[0m" && exit 1) @diff $(bin_dir)/scratch/LATEST-LICENSES-acmesolver cmd/acmesolver/LICENSES >/dev/null || (echo -e "\033[0;33mcmd/acmesolver/LICENSES seems to be out of date; update with 'make update-licenses'\033[0m" && exit 1) @diff $(bin_dir)/scratch/LATEST-LICENSES-cainjector cmd/cainjector/LICENSES >/dev/null || (echo -e "\033[0;33mcmd/cainjector/LICENSES seems to be out of date; update with 'make update-licenses'\033[0m" && exit 1) @diff $(bin_dir)/scratch/LATEST-LICENSES-startupapicheck cmd/startupapicheck/LICENSES >/dev/null || (echo -e "\033[0;33mcmd/startupapicheck/LICENSES seems to be out of date; update with 'make update-licenses'\033[0m" && exit 1) @diff $(bin_dir)/scratch/LATEST-LICENSES-controller cmd/controller/LICENSES >/dev/null || (echo -e "\033[0;33mcmd/controller/LICENSES seems to be out of date; update with 'make update-licenses'\033[0m" && exit 1) @diff $(bin_dir)/scratch/LATEST-LICENSES-webhook cmd/webhook/LICENSES >/dev/null || (echo -e "\033[0;33mcmd/webhook/LICENSES seems to be out of date; update with 'make update-licenses'\033[0m" && exit 1) @diff $(bin_dir)/scratch/LATEST-LICENSES-integration-tests test/integration/LICENSES >/dev/null || (echo -e "\033[0;33mtest/integration/LICENSES seems to be out of date; update with 'make update-licenses'\033[0m" && exit 1) @diff $(bin_dir)/scratch/LATEST-LICENSES-e2e-tests test/e2e/LICENSES >/dev/null || (echo -e "\033[0;33mtest/e2e/LICENSES seems to be out of date; update with 'make update-licenses'\033[0m" && exit 1) .PHONY: verify-crds verify-crds: | $(NEEDS_GO) $(NEEDS_CONTROLLER-GEN) $(NEEDS_YQ) ./hack/check-crds.sh $(GO) $(CONTROLLER-GEN) $(YQ) .PHONY: update-licenses update-licenses: rm -rf LICENSES cmd/acmesolver/LICENSES cmd/cainjector/LICENSES cmd/controller/LICENSES cmd/webhook/LICENSES cmd/startupapicheck/LICENSES test/integration/LICENSES test/e2e/LICENSES $(MAKE) LICENSES cmd/acmesolver/LICENSES cmd/cainjector/LICENSES cmd/controller/LICENSES cmd/webhook/LICENSES cmd/startupapicheck/LICENSES test/integration/LICENSES test/e2e/LICENSES .PHONY: update-crds update-crds: generate-test-crds patch-crds .PHONY: generate-test-crds generate-test-crds: | $(NEEDS_CONTROLLER-GEN) $(CONTROLLER-GEN) \ crd \ paths=./pkg/webhook/handlers/testdata/apis/testgroup/v{1,2}/... \ output:crd:dir=./pkg/webhook/handlers/testdata/apis/testgroup/crds PATCH_CRD_OUTPUT_DIR=./deploy/crds .PHONY: patch-crds patch-crds: | $(NEEDS_CONTROLLER-GEN) $(CONTROLLER-GEN) \ schemapatch:manifests=./deploy/crds \ output:dir=$(PATCH_CRD_OUTPUT_DIR) \ paths=./pkg/apis/... .PHONY: verify-codegen verify-codegen: | k8s-codegen-tools $(NEEDS_GO) VERIFY_ONLY="true" ./hack/k8s-codegen.sh \ $(GO) \ ./$(bin_dir)/tools/client-gen \ ./$(bin_dir)/tools/deepcopy-gen \ ./$(bin_dir)/tools/informer-gen \ ./$(bin_dir)/tools/lister-gen \ ./$(bin_dir)/tools/defaulter-gen \ ./$(bin_dir)/tools/conversion-gen \ ./$(bin_dir)/tools/openapi-gen .PHONY: update-codegen update-codegen: | k8s-codegen-tools $(NEEDS_GO) ./hack/k8s-codegen.sh \ $(GO) \ ./$(bin_dir)/tools/client-gen \ ./$(bin_dir)/tools/deepcopy-gen \ ./$(bin_dir)/tools/informer-gen \ ./$(bin_dir)/tools/lister-gen \ ./$(bin_dir)/tools/defaulter-gen \ ./$(bin_dir)/tools/conversion-gen \ ./$(bin_dir)/tools/openapi-gen # inject_helm_docs performs `helm-tool inject` using $1 as the output file and $2 as the values input define inject_helm_docs $(HELM-TOOL) inject --header-search '^' --footer-search '^' -i $2 -o $1 endef .PHONY: update-helm-docs update-helm-docs: deploy/charts/cert-manager/README.template.md deploy/charts/cert-manager/values.yaml | $(NEEDS_HELM-TOOL) $(call inject_helm_docs,deploy/charts/cert-manager/README.template.md,deploy/charts/cert-manager/values.yaml) .PHONY: verify-helm-docs verify-helm-docs: | $(NEEDS_HELM-TOOL) @if ! git diff --exit-code -- deploy/charts/cert-manager/README.template.md > /dev/null ; then \ echo "\033[0;33mdeploy/charts/cert-manager/README.template.md has been modified and could be out of date; update with 'make update-helm-docs'\033[0m" ; \ exit 1 ; \ fi @cp deploy/charts/cert-manager/README.template.md $(bin_dir)/scratch/LATEST_HELM_README-$(HELM-TOOL_VERSION) && $(call inject_helm_docs,$(bin_dir)/scratch/LATEST_HELM_README-$(HELM-TOOL_VERSION),deploy/charts/cert-manager/values.yaml) @diff $(bin_dir)/scratch/LATEST_HELM_README-$(HELM-TOOL_VERSION) deploy/charts/cert-manager/README.template.md || (echo -e "\033[0;33mdeploy/charts/cert-manager/README.template.md seems to be out of date; update with 'make update-helm-docs'\033[0m" && exit 1) .PHONY: update-all ## Update CRDs, code generation and licenses to the latest versions. ## This is provided as a convenience to run locally before creating a PR, to ensure ## that everything is up-to-date. ## ## @category Development update-all: update-crds update-codegen update-licenses update-helm-docs