Add a comment explaining the purpose of the script

Co-authored-by: Maël Valais <mael@vls.dev>
Signed-off-by: Richard Wall <richard.wall@jetstack.io>
This commit is contained in:
Richard Wall 2021-05-26 14:55:47 +01:00 committed by Richard Wall
parent 2e4ad05c56
commit bb82e007bc

View File

@ -128,6 +128,14 @@ def helm_chart_yaml(
version_file = "//:version",
**kwargs,
):
"""
We don't want alpha and beta releases to show on ArtifactHub as releases.
To prevent pre-releases from appearing, we use the ArtifactHub-specific
annotation:
artifacthub.io/prerelease: "true"
See https://artifacthub.io/docs/topics/annotations/helm/
"""
native.genrule(
name = name,
srcs = [version_file, chart_yaml_template],