ci: fix jira sync for closing issues (#27155)

Resolution must be explicitly set when transitioning an issue to
closed. This adds ability to set resolution on transition and updates
the sync workflow to resolve issue to done when closing.

Also updated the jira-query helper to output the response body on
error to make it easier to determine the cause.

Author: chrisroberts

.github/actions/jira/shared.bash

@@ -7,7 +7,7 @@ TEXT_CLEAR='\e[0m'
 
 # Make a request to the Jira API
 function jira-request() {
-  curl --show-error --location --fail \
+  curl --show-error --location --fail-with-body \
     --user "${JIRA_USER_EMAIL}:${JIRA_API_TOKEN}" \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \

.github/actions/jira/transition/action.yml

@@ -7,6 +7,9 @@ inputs:
   issue:
     required: true
     description: JIRA issue to transition
+  resolution:
+    required: false
+    description: Resolution name to apply to issue
   transition:
     required: true
     description: Transition name to apply to issue
@@ -20,3 +23,4 @@ runs:
     env:
       ISSUE: ${{ inputs.issue }}
       TRANSITION: ${{ inputs.transition }}
+      RESOLUTION: ${{ inputs.resolution }}

.github/actions/jira/transition/jira-transition.bash

@@ -25,17 +25,51 @@ if [ -z "${transition_id}" ]; then
     exit 1
 fi
 
-template='
+# If a resolution is set, find it and generate the template
+# with it included
+if [ -n "${RESOLUTION}" ]; then
+    # Grab the resolution ID
+    result="$(jira-request "${JIRA_BASE_URL}/rest/api/3/resolution")" || exit
+    query="$(printf '.[] | select(.name == "%s").id' "${RESOLUTION}")"
+    resolution_id="$(jq -r "${query}" <<< "${result}")"
+
+    if [ -z "${resolution_id}" ]; then
+        error "Could not find matching resolution with name matching '%s'" "${RESOLUTION}"
+        exit 1
+    fi
+
+    template='
 {
   transition: {
     id: $transition
+  },
+  fields: {
+    resolution: {
+      id: $resolution
+    }
   }
 }
 '
-issue_transition="$(jq -n --arg transition "${transition_id}" "${template}")" || exit
+    issue_transition="$(jq -n --arg transition "${transition_id}" --arg resolution "${resolution_id}" "${template}")" || exit
+else
+    # No resolution so the template only includes the transition
+    template='
+{
+  transition: {
+    id: $transition
+  }
+}
+'
+    issue_transition="$(jq -n --arg transition "${transition_id}" "${template}")" || exit
+fi
 
 info "Transitioning JIRA issue '%s' to %s (ID: %s)" "${ISSUE}" \
     "${TRANSITION}" "${transition_id}"
+if [ -n "${resolution_id}" ]; then
+    info "Resolving JIRA issue '%s' as %s (ID: %s)" "${ISSUE}" \
+        "${RESOLUTION}" "${resolution_id}"
+fi
+
 info "Transition payload:\n%s" "${issue_transition}"
 
 jira-request --request "POST" --data "${issue_transition}" \

.github/workflows/jira-sync.yml

@@ -58,6 +58,7 @@ jobs:
         with:
           issue: ${{ steps.search.outputs.issue }}
           transition: "Closed"
+          resolution: "Done"
       - name: Reopen ticket
         if: github.event.action == 'reopened' && steps.search.outputs.issue
         uses: ./.github/actions/jira/transition