Document usage of TPS scripts

heroku · Nov 13, 2024 · 24655e6 · 24655e6
1 parent 31f158f
commit 24655e6
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/scripts/postrelease/tps_record_release b/scripts/postrelease/tps_record_release
@@ -2,6 +2,15 @@
 set -eu
 set -o pipefail
 
+# Usage: ./scripts/postrelease/tps_record_release
+# Required env vars: TPS_API_TOKEN, COMPONENT_SLUG, RELEASE_SHA, ACTOR_EMAIL, APP_ID, STAGE
+
+# Alternate Usage: ./scripts/postrelease/tps_record_release <component-slug> <release-id>
+# Required env vars: TPS_API_TOKEN, ACTOR_EMAIL, APP_ID, STAGE
+
+# Alternate Usage: ./scripts/postrelease/tps_record_release <component-slug> <release-id> <email> <app-uuid> <stage>
+# Required env vars: TPS_API_TOKEN
+
 if [ -z "${TPS_HOSTNAME:-}" ]; then
   TPS_HOSTNAME="tps.heroku.tools"
 fi

diff --git a/scripts/release/tps_check_lock b/scripts/release/tps_check_lock
@@ -2,6 +2,12 @@
 set -eu
 set -o pipefail
 
+# Usage: ./scripts/release/tps_check_lock
+# Required env vars: TPS_API_TOKEN, COMPONENT_SLUG, RELEASE_SHA
+#
+# Alternate Usage: ./scripts/release/tps_check_lock <component-slug> <release-id>
+# Required env vars: TPS_API_TOKEN
+
 if [ -z "${TPS_HOSTNAME:-}" ]; then
   TPS_HOSTNAME="tps.heroku.tools"
 fi