From 9b5e92ecf4aa0748922b92f3f880e0d9c6c3ce2a Mon Sep 17 00:00:00 2001
From: Max Goldfarb <gfarb@github.com>
Date: Fri, 24 Feb 2023 11:49:25 -0500
Subject: [PATCH] Bug Fixes & Doc Updates (#46)

* Fix syntax bug in delete artifacts step of release branch merge handler workflow

* Remove duplicate SALESFORCE_TEMPLATE_USERNAME in getting started docs

* Fix bugs in compile release notes step

* Add DEPLOYMENT_TIMEOUT to getting started docs
---
 .../workflows/release-branch-merge-handler.yml  | 17 ++++++++++-------
 docs/Getting Started.md                         |  4 ++--
 2 files changed, 12 insertions(+), 9 deletions(-)

diff --git a/.github/workflows/release-branch-merge-handler.yml b/.github/workflows/release-branch-merge-handler.yml
index 0eedec1..51c100d 100644
--- a/.github/workflows/release-branch-merge-handler.yml
+++ b/.github/workflows/release-branch-merge-handler.yml
@@ -32,26 +32,29 @@ jobs:
       - name: Compile Release Notes
         if: steps.check_merge.outputs.IS_MERGE == 'true' && vars.GENERATE_RELEASE == 'true'
         run: |
-          if [ls release-notes/${{ vars.ISSUE_BRANCH_PREFIX }}*.md 1> /dev/null 2>&1]
+          if [ ls release-notes/${{ vars.ISSUE_BRANCH_PREFIX }}*.md 1> /dev/null 2>&1 ]
           then
-              if [ ! -f $1 ]
+              if [ ! -f release-notes/release.md ]
               then
-                  echo "### Includes the following items" > $1
-                  echo >> $1
+                  echo "### Includes the following items" > release-notes/release.md
+                  echo >> release-notes/release.md
               fi
               for ISSUE_NOTES in `ls release-notes/${{ vars.ISSUE_BRANCH_PREFIX }}*.md`
               do
                   NOTES=`cat ${ISSUE_NOTES}`
-                  if ! grep -q "${NOTES}" $1
+                  if ! grep -q "${NOTES}" release-notes/release.md
                   then
-                      echo "${NOTES}" >> $1
+                      echo "${NOTES}" >> release-notes/release.md
                   fi
               done
           fi
       - name: Delete Artifacts
         if: steps.check_merge.outputs.IS_MERGE == 'true'
         run: |
-          if [${{ vars.GENERATE_RELEASE }} == 'true']; then rm release-notes/${{ vars.ISSUE_BRANCH_PREFIX }}*.md || true
+          if [ "${{ vars.GENERATE_RELEASE }}" = "true" ]
+          then
+            rm release-notes/${{ vars.ISSUE_BRANCH_PREFIX }}*.md || true
+          fi
           rm auth/sandbox-login-url-issue-* || true
       - uses: stefanzweifel/git-auto-commit-action@v4.15.4
         if: steps.check_merge.outputs.IS_MERGE == 'true'
diff --git a/docs/Getting Started.md b/docs/Getting Started.md
index 70d8f82..379a359 100644
--- a/docs/Getting Started.md	
+++ b/docs/Getting Started.md	
@@ -18,8 +18,6 @@ The following secrets are required to be set in the repository settings:
   - This is the consumer key of the template org. This is used to authenticate with the template sandbox.
 - `SALESFORCE_TEMPLATE_USERNAME`
   - This is the username of the template org. This is used to authenticate with the template sandbox.
-- `SALESFORCE_TEMPLATE_USERNAME`
-  - This is the username of the template org. This is used to authenticate with the template sandbox.
 - `SALESFORCE_TEMPLATE_JWT_SECRET_KEY`
   - This is the private key used to generate the JWT token. This is used to authenticate with the template sandbox.
 - `BOT_USER_EMAIL`
@@ -41,3 +39,5 @@ The following repository variables are required to be set in the repository sett
   - This is feature flag that is a boolean value that determines whether release notes should be generated.
 - `SALESFORCE_FORMATTED_PROFILES_AND_PERMS`
   - This is a feature flag that is a boolean value that determines whether profiles and permissions should be formatted using the `profile:decompose` plugin.
+- `DEPLOYMENT_TIMEOUT`
+  - The number of minutes to wait for the `force:source:deploy` command to complete and display results.