They can then be extracted using remake --tasks, e.g.:
$ remake --tasks
all Install Camunda on Kubernetes
clean Uninstall Camunda from Kubernetes
clean-kube Delete entire Kubernetes cluster including metrics data
kube Create Kubernetes cluster and install Prometheus & Grafana
url-grafana Get URL for Grafana
urls Get URLs for Kubernetes cluster
And since not everyone has remake installed we can add these to the README.md that accompanies each Helm profile. This would also help people that don't get shell completion for make.
This proposal might be controversial and against best practices of
make
, but the.PHONY
declarations are mostly redundant, which makes ourMakefile
s harder to read and has more than once lead to inconsistencies like this: https://github.com/camunda-community-hub/camunda-8-helm-profiles/blob/main/google/include/kubernetes-gke.mk#L31-L32Let's remove them and instead introduce documentation in form of
remake
task descriptions, e.g.:They can then be extracted using
remake --tasks
, e.g.:And since not everyone has remake installed we can add these to the
README.md
that accompanies each Helm profile. This would also help people that don't get shell completion formake
.I am already working on a PR for this.