Merge pull request #16 from emerald-squad/custom-comment

 Add a custom comment after the comment made by the resource

Author: laurentverbruggen

README.md

@@ -114,6 +114,13 @@ Set the status message on specified pull request.
 
   * [`on_success`](https://concourse.ci/on-success-step.html) and [`on_failure`](https://concourse.ci/on-failure-step.html) triggers may be useful for you when you wanted to reflect build result to the pull request (see the example below).
 
+* `comment`: *Optional.* A custom comment that you want added to the status message.
+  Any occurence of `[[BRANCH]]` will be replace by the actual branch name form the
+  pull request.
+
+* `commentFile`: *Optional.* The path to a file that contains a custom comment to
+  add to the message. This allow the comment to be built by a previous task in the job.
+
 ## Example pipeline
 
 ```yaml

assets/helpers/bitbucket.sh

@@ -158,26 +158,33 @@ bitbucket_pullrequest_progress_comment() {
   # $2: hash of merge commit
   # $3: hash of source commit
   # $4: hash of target commit
+  # $5: custom comment
   local hash="$2"
 
   local progress_msg_end=""
+  local custom_comment=""
+
   if [ "$hash" == "$3" ]; then
     progress_msg_end+=" into $4]"
   else
     progress_msg_end="] $3 into $4"
   fi
 
+  if [ -n "$5" ]; then
+    custom_comment="\n\n$5"
+  fi
+
   local build_url="$ATC_EXTERNAL_URL/teams/$(rawurlencode "$BUILD_TEAM_NAME")/pipelines/$(rawurlencode "$BUILD_PIPELINE_NAME")/jobs/$(rawurlencode "$BUILD_JOB_NAME")/builds/$(rawurlencode "$BUILD_NAME")"
   local build_result_pre=" \n\n **["
   local build_result_post="]($build_url)** - Build #$BUILD_NAME"
 
   case "$1" in
     success)
-      echo "$(bitbucket_pullrequest_progress_msg_start "$hash" "Finished")${progress_msg_end}${build_result_pre}✓ BUILD SUCCESS${build_result_post}" ;;
+      echo "$(bitbucket_pullrequest_progress_msg_start "$hash" "Finished")${progress_msg_end}${build_result_pre}✓ BUILD SUCCESS${build_result_post}${custom_comment}" ;;
     failure)
-      echo "$(bitbucket_pullrequest_progress_msg_start "$hash" "Finished")${progress_msg_end}${build_result_pre}✕ BUILD FAILED${build_result_post}" ;;
+      echo "$(bitbucket_pullrequest_progress_msg_start "$hash" "Finished")${progress_msg_end}${build_result_pre}✕ BUILD FAILED${build_result_post}${custom_comment}" ;;
     pending)
-      echo "$(bitbucket_pullrequest_progress_msg_start "$hash" "Started")${progress_msg_end}${build_result_pre}⌛ BUILD IN PROGRESS${build_result_post}" ;;
+      echo "$(bitbucket_pullrequest_progress_msg_start "$hash" "Started")${progress_msg_end}${build_result_pre}⌛ BUILD IN PROGRESS${build_result_post}${custom_comment}" ;;
   esac
 }
 

assets/out

@@ -41,6 +41,8 @@ rebuild_phrase=$(jq -r '.source.rebuild_phrase // "test this please"' < "$payloa
 
 path=$(jq -r '.params.path // ""' < "$payload")
 status=$(jq -r '.params.status // ""' < "$payload")
+additionnal_comment=$(jq -r '.params.comment // ""' < "$payload")
+additionnal_comment_file=$(jq -r '.params.commentFile // ""' < "$payload")
 
 configure_git_ssl_verification "$skip_ssl_verification"
 configure_git_global "${git_config_payload}"
@@ -61,14 +63,20 @@ if [ -z "$status" ]; then
 fi
 
 cd "$source"
+
+if [ -n "$additionnal_comment_file" ]; then
+  additionnal_comment="$(<${additionnal_comment_file})"
+fi
+
 cd "$path"
 
 merge_commit=$(git rev-parse HEAD)
 ls_remote=$(git ls-remote "$uri")
 
-# collect prq id from git config stored in git config (during get step)
+# collect prq id and branch name from git config stored in git config (during get step)
 # included cat to catch error
 prq_number=$(git config --get pullrequest.id | cat)
+branch=$(git config --get pullrequest.branch | cat)
 
 if [ -z "$prq_number" ]; then
   prqs=$(echo "$ls_remote" | grep -E "/pull\-requests/[0-9]+" | grep "$merge_commit" | cat)
@@ -143,8 +151,13 @@ bitbucket_pullrequest_commit_status "$repo_host" "$source_commit" "$data" "" ""
 # use the pullrequest date stored in git config in get
 prq_verify_date=$(git config --get pullrequest.date | cat)
 
+# Add branch name to additional comment
+if [ -n "$additionnal_comment" ]; then
+  additionnal_comment="${additionnal_comment//\[\[BRANCH\]\]/$branch}"
+fi
+
 # add comment to pull request to track if build was started/finished
-comment_message=$(bitbucket_pullrequest_progress_comment "$status" "$prq_hash" "$source_commit" "$target_commit")
+comment_message=$(bitbucket_pullrequest_progress_comment "$status" "$prq_hash" "$source_commit" "$target_commit", "$additionnal_comment")
 comments=$(bitbucket_pullrequest_overview_comments "$repo_host" "$repo_project" "$repo_name" "$prq_number" "" "$skip_ssl_verification" | jq -c '.[]')
 commented=""
 skip_verify=false