From bb82e007bc8b0b0343eea2dfb6728814dd259188 Mon Sep 17 00:00:00 2001
From: Richard Wall <wallrj@users.noreply.github.com>
Date: Wed, 26 May 2021 14:55:47 +0100
Subject: [PATCH] Add a comment explaining the purpose of the script
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Maël Valais <mael@vls.dev>
Signed-off-by: Richard Wall <richard.wall@jetstack.io>
---
 build/helm.bzl | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/build/helm.bzl b/build/helm.bzl
index 06eb517bf..849c3d657 100644
--- a/build/helm.bzl
+++ b/build/helm.bzl
@@ -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],