From c5dda0995bcce17e422886a140cdf9e2163a7706 Mon Sep 17 00:00:00 2001
From: Scott Rigby <scott@r6by.com>
Date: Tue, 21 Feb 2023 00:40:58 -0500
Subject: [PATCH] Add why comments

Signed-off-by: Scott Rigby <scott@r6by.com>
---
 .github/workflows/release.yml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 3b77dcf4a..96a06c73c 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -7,6 +7,11 @@ on:
     branches:
       - main
 
+# Note the only differences between release and canary-release jobs are:
+# - only canary passes --overwrite flag
+# - the VERSION make variable passed to 'make dist checksum' is expected to
+#   be "canary" if the job is triggered by a push to "main" branch. If the
+#   job is triggered by a tag push, VERSION should be the tag ref.
 jobs:
   release:
     if: ${{ startsWith(github.ref, 'refs/tags/v') && github.repository_owner == 'helm' }}
@@ -65,4 +70,5 @@ jobs:
           container_name: ${{ secrets.AZURE_STORAGE_CONTAINER_NAME }}
           connection_string: ${{ secrets.AZURE_STORAGE_CONNECTION_STRING }}
           extra_args: '--pattern helm-*'
+          # WARNING: this will overwrite existing blobs in your blob storage
           overwrite: 'true'