azure-set-vars: add header comments

Explain what the two scripts do.

Also add a comment for the AZURE_DEVOPS_EXT_PAT variable, which may seem
unused ('az' uses it automatically)

Signed-off-by: Adam Cmiel <[email protected]>

Author: chmeliik

hack/_azure-set-vars.sh

@@ -1,7 +1,16 @@
 #!/bin/bash
 set -o errexit -o pipefail
 
-: "${AZURE_DEVOPS_EXT_PAT:?}"
+# Create a variable group called $AZURE_VARIABLE_GROUP_NAME (if it doesn't exist)
+# and set all the variables needed for the RHTAP pipeline.
+#
+# If you have the Azure CLI (az) installed and don't mind running the commands
+# in this script on your machine, you can execute this script directly. Otherwise,
+# run this in a container via hack/azure-set-vars.sh
+#
+# Before running this script, source your .env or .envrc file.
+
+: "${AZURE_DEVOPS_EXT_PAT:?}" # the 'az' commands use this variable automatically
 : "${AZURE_VARIABLE_GROUP_NAME:?}"
 : "${AZURE_ORGANIZATION:?}"
 : "${AZURE_PROJECT:?}"

hack/azure-set-vars.sh

@@ -1,6 +1,9 @@
 #!/bin/bash
 set -o errexit -o nounset -o pipefail
 
+# Run a script in the azure-cli container to set Azure variables.
+# See the header in hack/_azure-set-vars.sh for more details.
+
 SCRIPTDIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" > /dev/null 2>&1 && pwd)"
 
 # Find available versions with