Merge pull request #6639 from ThatsMrTalbot/feat/auto-generate-helm-docs

Auto generate Helm docs
This commit is contained in:
jetstack-bot 2024-01-16 09:07:25 +00:00 committed by GitHub
commit 93bbb35bc7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 4643 additions and 324 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -109,10 +109,14 @@ update-codegen: | k8s-codegen-tools $(NEEDS_GO)
./$(BINDIR)/tools/conversion-gen \
./$(BINDIR)/tools/openapi-gen
.PHONY: update-helm-docs
update-helm-docs: | $(NEEDS_HELM-TOOL)
$(HELM-TOOL) inject --header-search '^<!-- AUTO-GENERATED -->' --footer-search '^<!-- /AUTO-GENERATED -->' -i deploy/charts/cert-manager/values.yaml -o deploy/charts/cert-manager/README.template.md
.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-all: update-crds update-codegen update-licenses update-helm-docs

View File

@ -65,6 +65,8 @@ TOOLS += boilersuite=v0.1.0
TOOLS += ginkgo=$(shell awk '/ginkgo\/v2/ {print $$2}' go.mod)
# https://github.com/golangci/golangci-lint/releases
TOOLS += golangci-lint=v1.55.2
# https://github.com/cert-manager/helm-tool
TOOLS += helm-tool=v0.2.1
# Version of Gateway API install bundle https://gateway-api.sigs.k8s.io/v1alpha2/guides/#installing-gateway-api
GATEWAY_API_VERSION=v1.0.0
@ -243,6 +245,7 @@ GO_DEPENDENCIES += gotestsum=gotest.tools/gotestsum
GO_DEPENDENCIES += crane=github.com/google/go-containerregistry/cmd/crane
GO_DEPENDENCIES += boilersuite=github.com/cert-manager/boilersuite
GO_DEPENDENCIES += golangci-lint=github.com/golangci/golangci-lint/cmd/golangci-lint
GO_DEPENDENCIES += helm-tool=github.com/cert-manager/helm-tool
define go_dependency
$$(BINDIR)/downloaded/tools/$1@$($(call UC,$1)_VERSION)_%: | $$(NEEDS_GO) $$(BINDIR)/downloaded/tools