description

Author: nkammah

.buildkite/build_pr_pipeline.yml

@@ -1,7 +1,7 @@
 steps:
   - key: "build-pr-setup"
     label: "setup"
-    command: ".buildkite/scripts/build_pr_commit_status.sh pending"
+    command: ".buildkite/scripts/build_pr_commit_status.sh pending 'Build started'"
   - key: "build-pr"
     label: ":hammer: Build docs PR"
     command: echo 'hello' #".buildkite/scripts/build_pr.sh"
@@ -15,9 +15,9 @@ steps:
     label: "teardown"
     command: |
       if [ $(buildkite-agent step get "outcome" --step "build-pr") == "passed" ]; then
-        .buildkite/scripts/build_pr_commit_status.sh 'success'
+        .buildkite/scripts/build_pr_commit_status.sh 'success' 'Build finished'
       else
-        .buildkite/scripts/build_pr_commit_status.sh 'failure'
+        .buildkite/scripts/build_pr_commit_status.sh 'failure' 'Build finished'
       fi
     depends_on:
       - step: "build-pr"

.buildkite/scripts/build_pr_commit_status.sh

@@ -7,20 +7,28 @@ if [ -z ${GITHUB_PR_OWNER+set} ] || [ -z ${GITHUB_PR_REPO+set} ] || [ -z ${GITHU
   exit 0
 fi
 
-status_status=$1
+
+if [ $# -lt 2 ]; then
+  echo "Usage: $0 <state> <description>"
+  exit 1
+fi
+
+status_state=$1
+description=$2
+
 case $status_state in
     pending|success|failure|error)
       echo "Setting buildkite/docs commit status to ${status_state}";;
     *)
-      echo "Commit state not specified - exiting"
+      echo "Invalid state"
       exit 1;;
 esac
 set -x
 echo "The value of my secret is $MY_SECRET"
 
 githubPublishStatus="https://api.github.com/repos/${GITHUB_PR_OWNER}/${GITHUB_PR_REPO}/statuses/${GITHUB_PR_TRIGGERED_SHA}"
 
-data='{"state":"'$status_state'","target_url":"'$BUILDKITE_BUILD_URL'","description":"Build finished.","context":"buildkite/'$BUILDKITE_PIPELINE_SLUG'"}'
+data='{"state":"'$status_state'","target_url":"'$BUILDKITE_BUILD_URL'","description":"'$description'","context":"buildkite/'$BUILDKITE_PIPELINE_SLUG'"}'
 
 curl -s -L \
   -X POST \