search

masmovil / masorange_rules_helm

Bazel rules to manipulate and operate Helm charts with Bazel, decrpyt sops secrets, and run operations over cloud services
Apache License 2.0
61 stars 32 forks source link

Generate documentation using Stardoc #34

Closed ar3s3ru closed 1 week ago

ar3s3ru commented 3 years ago

I've noticed that the rules documentation, currently in the README, are out-of-date from the actual rules implementations. Example: #32 introduced new fields in helm_release, which are not reflected in the README.

An idea to remove this inconsistency could be to use Stardoc to automatically generate documentation.

rules_docker for example uses it for the container_* targets. More info here: https://github.com/bazelbuild/rules_docker/pull/1890

pmoncadaisla commented 2 years ago

Thanks @ar3s3ru , you are right, documentation is not up to date, and your solution is pretty atractive! We will look into this. We have a new release of rules comming, which are backwards compatible but they have been rewritten from zero. Now they are written in Go rathen than bash. They solve some race conditions issues and they are friendlier with remote build execution systems.

danigar commented 1 week ago

We are generating the rules docs with stardoc in new v1.0.0.