feat: add Makefile command for updating auto-generated docs #2014
Conversation
Signed-off-by: Yash Pimple <yashpimple22@gmail.com>
github-actions
bot
added
the
documentation
✅ Deploy Preview for keptn-lifecycle-toolkit ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Kudos, SonarCloud Quality Gate passed!
|
mowies
changed the title
| @@ -46,3 +46,34 @@ markdownlint: | |||
|
|
|||
| markdownlint-fix: | |||
| $(MDL_CMD) --entrypoint="markdownlint-cli2-fix" davidanson/markdownlint-cli2-rules:${MDL_DOCKER_VERSION} "**/*.md" | |||
|
|
|||
| # Define the directories | |||
There was a problem hiding this comment.
I suppose these changes are to be made in metrics-operator/Makefile and lifecycle-operator/Makefile. It doesn't make sense to regenerate the resources for lifecycle-operator, if the API has been changed for only the metrics-operator.
There was a problem hiding this comment.
We'll focus on updating the metrics-operator/Makefile accordingly to target the specific API changes
|
|
||
| generate-manifests: | ||
| @echo "Generating manifests..." | ||
| cd $(OPERATOR_DIR) && make generate && make manifests |
There was a problem hiding this comment.
please use make -C $(OPERATOR_DIR) to call make command from sub-makefiles. same for metrics operator
|
|
||
| copy-manifests: | ||
| @echo "Copying manifests to Helm..." | ||
| cp $(CONFIG_DIR)/crd/bases/*.yaml $(HELM_TEMPLATES_DIR)/ |
There was a problem hiding this comment.
you will need to use kustomize to generate the crds here. just copying the yaml files will not be enough since there are some patch files that are applied to the CRD yamls by kustomize
| awk '/metadata:/{print;print " labels:\n app.kubernetes.io/part-of: keptn-lifecycle-toolkit\n crdGroup: metrics.keptn.sh\n keptn.sh/inject-cert: \"true\"";next}1' $$file > $$tmpfile; \ | ||
| awk '/metadata:/{print;print " annotations:\n cert-manager.io/inject-ca-from: \"{{ .Release.Namespace }}/klt-certs\"";next}1' $$tmpfile > $$file; \ |
There was a problem hiding this comment.
i would prefer doing this in a different way. is there a way to patch the yaml with kustomize for example?
we did that before here: https://github.com/keptn/lifecycle-toolkit/blob/v0.7.1/helm/overlay/kustomization.yaml
|
|
||
| update-crd-docs: | ||
| @echo "Updating CRD docs..." | ||
| cd .github/scripts/generate-crd-docs/ && ./generate-crd-docs.sh |
There was a problem hiding this comment.
| cd .github/scripts/generate-crd-docs/ && ./generate-crd-docs.sh | |
| ./.github/scripts/generate-crd-docs/generate-crd-docs.sh |
|
Hey @YashPimple are you working on this still? |
Hello @RealAnna I apologize for the oversight, I forgot about it. I'll promptly make a PR soon. Thank You for your patience and support! |
|
any updates on this @YashPimple ? :) |
|
This PR has been automatically marked as stale because it has not had recent activity. It will be |
|
Again asking for updates... @YashPimple |
Hello @mowies sorry for the late update. |
Hi @YashPimple can you please share more details about the issue you are having with this one? |
|
Hi @YashPimple any updates on this PR? |
|
Closing this PR due to inactivity as the issue is already assigned to another contributor. Please feel free to look and take other tickets if you are interested! |
Fix #1879
Changes made:
resources.