From 713dae4044621ee831c1bdabba70f43bb4452d77 Mon Sep 17 00:00:00 2001
From: Jack Baldry <jack.baldry@grafana.com>
Date: Thu, 27 Jun 2024 12:11:13 +0100
Subject: [PATCH] Fix workflow for regenerating tutorials when there's an
 existing PR

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---
 .github/workflows/regenerate-tutorials.yml |  6 ++-
 scripts/check-out-branch.bash              | 43 ++++++++++++++++++++++
 scripts/manage-pr.bash                     | 38 +++++++++----------
 3 files changed, 64 insertions(+), 23 deletions(-)
 create mode 100755 scripts/check-out-branch.bash

diff --git a/.github/workflows/regenerate-tutorials.yml b/.github/workflows/regenerate-tutorials.yml
index 0a4c5e5..c0171ec 100644
--- a/.github/workflows/regenerate-tutorials.yml
+++ b/.github/workflows/regenerate-tutorials.yml
@@ -16,19 +16,21 @@ jobs:
           path: loki
       - uses: actions/checkout@v4
         with:
-          ref: staging
           path: killercoda
       - uses: actions/setup-go@v5
         with:
           go-version-file: killercoda/tools/transformer/go.mod
       - run: go build ./
         working-directory: killercoda/tools/transformer
+      - run: ./scripts/check-out-branch.bash
+        shell: bash
+        working-directory: killercoda
       - run: >
           ./transformer
           "${GITHUB_WORKSPACE}/loki/docs/sources/get-started/quick-start.md"
           "${GITHUB_WORKSPACE}/killercoda/loki/loki-quickstart"
         working-directory: killercoda/tools/transformer
-      - run: ./scripts/manage-pr.bash
+      - run: ./scripts/open-pr.bash
         env:
           GH_TOKEN: ${{ github.token }}
         shell: bash
diff --git a/scripts/check-out-branch.bash b/scripts/check-out-branch.bash
new file mode 100755
index 0000000..7bf54ba
--- /dev/null
+++ b/scripts/check-out-branch.bash
@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+
+set -euf -o pipefail
+
+function usage {
+  cat <<EOF
+Check out the branch for regenerating tutorials.
+
+Usage:
+  $0
+
+Examples:
+  $0
+EOF
+}
+
+if [[ $# -ne 0 ]]; then
+  usage
+  exit 1
+fi
+
+readonly BRANCH="${BRANCH:-update-generated-tutorials}"
+
+PR_STATUS=$(gh pr view "${BRANCH}" --json state --jq .state || true)
+readponly PR_STATUS
+
+if [[ "${PR_STATUS}" == OPEN ]]; then
+  gh pr checkout "${BRANCH}"
+
+  if ! git diff --exit-code; then
+    commit
+    git push
+  fi
+
+  exit 0
+fi
+
+# Remove the remote branch if it exists because there is no PR associated with it.
+if git fetch origin "${BRANCH}"; then
+  git push origin --delete "${BRANCH}"
+fi
+
+git checkout -b "${BRANCH}"
diff --git a/scripts/manage-pr.bash b/scripts/manage-pr.bash
index 1b43034..c366afb 100755
--- a/scripts/manage-pr.bash
+++ b/scripts/manage-pr.bash
@@ -2,6 +2,23 @@
 
 set -euf -o pipefail
 
+function usage {
+  cat <<EOF
+Open a PR for updating generated tutorials if there are changes.
+
+Usage:
+  $0
+
+Examples:
+  $0
+EOF
+}
+
+if [[ $# -ne 0 ]]; then
+  usage
+  exit 1
+fi
+
 readonly BRANCH="${BRANCH:-update-generated-tutorials}"
 readonly SUBJECT="${SUBJECT:-Update generated tutorials}"
 
@@ -13,27 +30,6 @@ function commit {
   git commit --message "${SUBJECT}"
 }
 
-PR_STATUS=$(gh pr view "${BRANCH}" --json state --jq .state || true)
-readonly PR_STATUS
-
-if [[ "${PR_STATUS}" == OPEN ]]; then
-  gh pr checkout "${BRANCH}"
-
-  if ! git diff --exit-code; then
-    commit
-    git push
-  fi
-
-  exit 0
-fi
-
-# Remove the remote branch if it exists because there is no PR associated with it.
-if git fetch origin "${BRANCH}"; then
-  git push origin --delete "${BRANCH}"
-fi
-
-git checkout -b "${BRANCH}"
-
 if ! git diff --exit-code; then
   commit
   git push origin "refs/heads/${BRANCH}"