Skip to content
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

add crd-ref-docs #524

Merged
merged 1 commit into from
May 6, 2024
Merged

add crd-ref-docs #524

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
55 changes: 31 additions & 24 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,23 +75,17 @@ all: build
manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases

# stripped-down-crds is a version of the whizard CRDs with all
# description fields being removed. It is meant as a workaround for the issue
# that `kubectl apply -f ...` might fail with the full version of the CRDs
# because of too long annotations field.
# See https://github.com/prometheus-operator/prometheus-operator/issues/4355
stripped-down-crds: manifests
cd config/crd/bases && \
for f in *.yaml; do \
echo "---" > ../../../charts/whizard/crds/$$f; \
gojsontoyaml -yamltojson < $$f | jq 'walk(if type == "object" then with_entries(if .value|type=="object" then . else select(.key | test("description") | not) end) else . end)' | gojsontoyaml >> ../../../charts/whizard/crds/$$f; \
done && \
cp -rf ../../../charts/whizard/crds ../../../charts/whizard-crds/;


generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."

clientset:
./hack/generate_client.sh $(GV)

bundle: manifests kustomize
cd config/manager && $(KUSTOMIZE) edit set image controller=$(CONTROLLER_MANAGER_IMG)
cd config/default && $(KUSTOMIZE) edit set namespace kubesphere-monitoring-system
$(KUSTOMIZE) build config/default > config/bundle.yaml

fmt: ## Run go fmt against code.
go fmt ./...

Expand Down Expand Up @@ -159,6 +153,10 @@ KUSTOMIZE = $(shell pwd)/bin/kustomize
kustomize: ## Download kustomize locally if necessary.
$(call go-get-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/[email protected])

CRD-REF-DOCS =$(shell pwd)/bin/crd-ref-docs
crd-ref-docs: ## Download crd-ref-docs locally if necessary.
$(call go-get-tool,$(CRD-REF-DOCS),github.com/elastic/[email protected])

# go-get-tool will 'go get' any package $2 and install it to $1.
PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
define go-get-tool
Expand All @@ -173,18 +171,27 @@ rm -rf $$TMP_DIR ;\
}
endef

clientset:
./hack/generate_client.sh $(GV)

bundle: manifests kustomize
cd config/manager && $(KUSTOMIZE) edit set image controller=$(CONTROLLER_MANAGER_IMG)
cd config/default && $(KUSTOMIZE) edit set namespace kubesphere-monitoring-system
$(KUSTOMIZE) build config/default > config/bundle.yaml
docgen: crd-ref-docs
$(CRD-REF-DOCS) \
--source-path=./pkg/api/monitoring/v1alpha1 \
--config=./tools/docgen/config.yaml \
--output-path=./docs/monitoring/api.md \
--renderer=markdown

MONITORING_TYPE_GOES=$(shell find pkg/api/monitoring -name *_types.go | tr '\n' ' ')
docs/monitoring/api.md: tools/docgen/docgen.go $(TYPE_GOES)
go run github.com/kubesphere/whizard/tools/docgen $(MONITORING_TYPE_GOES) > docs/monitoring/api.md
# stripped-down-crds is a version of the whizard CRDs with all
# description fields being removed. It is meant as a workaround for the issue
# that `kubectl apply -f ...` might fail with the full version of the CRDs
# because of too long annotations field.
# See https://github.com/prometheus-operator/prometheus-operator/issues/4355
stripped-down-crds: manifests
cd config/crd/bases && \
for f in *.yaml; do \
echo "---" > ../../../charts/whizard/crds/$$f; \
gojsontoyaml -yamltojson < $$f | jq 'walk(if type == "object" then with_entries(if .value|type=="object" then . else select(.key | test("description") | not) end) else . end)' | gojsontoyaml >> ../../../charts/whizard/crds/$$f; \
done && \
cp -rf ../../../charts/whizard/crds ../../../charts/whizard-crds/;

update-helm-appVersion: ## Update appVersion in helm chart.
cut-new-version: stripped-down-crds ## Update appVersion in helm chart.
$(shell sed -i '' -e 's/appVersion:.*/appVersion: "'$(VERSION)'"/g' charts/whizard/Chart.yaml)

12 changes: 6 additions & 6 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ From now on, all work happens on the `release-<major>.<minor>` branch.

Bump the version in the `VERSION` file in the root of the repository.

Then `make update-helm-appVersion` to update the helm appVersion information.
Then `make cut-new-version` to update the helm appVersion information.

Images will be automatically built and pushed whenever code changes or a tag is created. If users want to build images manually, use the following command:

Expand All @@ -84,13 +84,13 @@ tag="$(< VERSION)"
git tag -a "${tag}" -m "${tag}"
git push origin "${tag}"
```

Commit all the changes.

Finally, create a new release:

- Go to https://github.com/WhizardTelemetry/whizard/releases/new.
- Associate the new release with the previously pushed tag.
- Add release notes based on `CHANGELOG.md`.

* Go to https://github.com/WhizardTelemetry/whizard/releases/new.
* Associate the new release with the previously pushed tag.
* Add release notes based on `CHANGELOG.md`.

For patch releases, cherry-pick the commits from the release branch into the master branch.
For patch releases, cherry-pick the commits from the release branch into the master branch.
Loading