Change status and assignee of Jira ticket

Overview

This self-service guide facilitates transitioning the status and assignee of a Jira ticket from Port using Port's self service actions. With this, you can manage ticket (issue) status without leaving Port.

Prerequisites

1. Port's GitHub app needs to be installed.

2. In your GitHub repository, go to Settings > Secrets and add the following secrets:

   • JIRA_API_TOKEN - Jira API token generated by the user.
   • JIRA_BASE_URL - The URL of your Jira organization. For example, https://your-organization.atlassian.net.
   • JIRA_USER_EMAIL - The email of the Jira user that owns the Jira API token.
   • PORT_AUTH_CLIENT_ID - Your port client id How to get the credentials.
   • PORT_AUTH_CLIENT_SECRET - Your port client secret How to get the credentials.

3. Optional - Install Port's Jira integration learn more

   Jira Integration

   This step is not required for this example, but it will create all the blueprint boilerplate for you, and also ingest and update the catalog in real time with your Jira Issues.

4. In Case you decided not to install the Jira integration, you will need to create a blueprint for the Jira issue in Port.

   Jira Issue Blueprint

   {
     "identifier": "jiraIssue",
     "title": "Jira Issue",
     "icon": "Jira",
     "schema": {
       "properties": {
         "url": {
           "title": "Issue URL",
           "type": "string",
           "format": "url",
           "description": "URL to the issue in Jira"
         },
         "status": {
           "title": "Status",
           "type": "string",
           "description": "The status of the issue"
         },
         "issueType": {
           "title": "Type",
           "type": "string",
           "description": "The type of the issue"
         },
         "components": {
           "title": "Components",
           "type": "array",
           "description": "The components related to this issue"
         },
         "assignee": {
           "title": "Assignee",
           "type": "string",
           "format": "user",
           "description": "The user assigned to the issue"
         },
         "reporter": {
           "title": "Reporter",
           "type": "string",
           "description": "The user that reported to the issue",
           "format": "user"
         },
         "creator": {
           "title": "Creator",
           "type": "string",
           "description": "The user that created to the issue",
           "format": "user"
         },
         "priority": {
           "title": "Priority",
           "type": "string",
           "description": "The priority of the issue"
         },
         "created": {
           "title": "Created At",
           "type": "string",
           "description": "The created datetime of the issue",
           "format": "date-time"
         },
         "updated": {
           "title": "Updated At",
           "type": "string",
           "description": "The updated datetime of the issue",
           "format": "date-time"
         }
       }
     },
     "calculationProperties": {},
     "relations": {}
   }

GitHub Workflow

Create the file .github/workflows/change-jira-ticket-status-and-assignee.yml in the .github/workflows folder of your repository.

tip

We recommend creating a dedicated repository for the workflows that are used by Port actions.

GitHub Workflow

change-jira-ticket-status-and-assignee.yml

name: Change Jira Ticket Status and Assignee
on:
  workflow_dispatch:
    inputs:
      status:
        type: string
        required: false
      assignee:
        type: string
        required: false
      port_payload:
        required: true
        description:
          Port's payload, including details for who triggered the action and
          general context (blueprint, run id, etc...)
        type: string
    secrets:
      JIRA_BASE_URL:
        required: true
      JIRA_USER_EMAIL:
        required: true
      JIRA_API_TOKEN:
        required: true
      PORT_CLIENT_ID:
        required: true
      PORT_CLIENT_SECRET:
        required: true

jobs:
  change-jira-ticket-status-and-assignee:
    runs-on: ubuntu-latest
    outputs:
      selected_user_id: ${{ steps.user_list_from_search.outputs.selected_user_id }}
      selected_user_name: ${{ steps.user_list_from_search.outputs.selected_user_name }}

    steps:
      - name: Login
        uses: atlassian/gajira-login@v3
        env:
          JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
          JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
          JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}

      - name: Inform starting of changing Jira ticket status
        id: inform_ticket_start
        if: ${{ github.event.inputs.status }}
        uses: port-labs/port-github-action@v1
        with:
          clientId: ${{ secrets.PORT_CLIENT_ID }}
          clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
          operation: PATCH_RUN
          runId: ${{ fromJson(inputs.port_payload).context.runId }}
          logMessage: |
            Changing status of Jira issue... ⛴️

      - name: Inform skipping of changing Jira ticket status
        id: inform_skip_ticket_status
        if: steps.inform_ticket_start.outcome == 'skipped'
        uses: port-labs/port-github-action@v1
        with:
          clientId: ${{ secrets.PORT_CLIENT_ID }}
          clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
          operation: PATCH_RUN
          runId: ${{ fromJson(inputs.port_payload).context.runId }}
          logMessage: |
            Status field is blank, skipping status change... ⛴️

      - name: Transition issue
        id: transition_issue_status
        if: steps.inform_ticket_start.outcome == 'success'
        uses: atlassian/gajira-transition@v3
        with:
          issue: ${{ fromJson(inputs.port_payload).context.entity }}
          transition: ${{ github.event.inputs.status }}

      - name: Inform that status has been changed
        if: steps.transition_issue_status.outcome == 'success'
        uses: port-labs/port-github-action@v1
        with:
          clientId: ${{ secrets.PORT_CLIENT_ID }}
          clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
          operation: PATCH_RUN
          link: ${{ secrets.JIRA_BASE_URL }}/browse/${{ fromJson(inputs.port_payload).context.entity }}
          runId: ${{ fromJson(inputs.port_payload).context.runId }}
          logMessage: |
            Jira issue status changed to ${{ github.event.inputs.status }}! ✅

      - name: Inform starting of changing Jira ticket assignee
        id: inform_assignee_start
        if: ${{ github.event.inputs.assignee }}
        uses: port-labs/port-github-action@v1
        with:
          clientId: ${{ secrets.PORT_CLIENT_ID }}
          clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
          operation: PATCH_RUN
          runId: ${{ fromJson(inputs.port_payload).context.runId }}
          logMessage: |
            Assigning ticket to user... ⛴️

      - name: Inform skipping of changing Jira ticket assignee
        id: inform_skip_assignee
        if: steps.inform_assignee_start.outcome == 'skipped'
        uses: port-labs/port-github-action@v1
        with:
          clientId: ${{ secrets.PORT_CLIENT_ID }}
          clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
          operation: PATCH_RUN
          runId: ${{ fromJson(inputs.port_payload).context.runId }}
          logMessage: |
            Assignee field is blank, skipping assigning of ticket... ⛴️

      - name: Inform searching of user in user list
        if: steps.inform_skip_assignee.outcome == 'skipped'
        uses: port-labs/port-github-action@v1
        with:
          clientId: ${{ secrets.PORT_CLIENT_ID }}
          clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
          operation: PATCH_RUN
          runId: ${{ fromJson(inputs.port_payload).context.runId }}
          logMessage: |
            Searching for user in organization user list... ⛴️

      - name: Search for assignee among user list
        id: search_for_assignee
        if: steps.inform_skip_assignee.outcome == 'skipped'
        uses: fjogeleit/http-request-action@v1
        with:
          url: "${{ secrets.JIRA_BASE_URL }}/rest/api/3/user/search?query=${{ github.event.inputs.assignee }}"
          method: "GET"
          username: ${{ secrets.JIRA_USER_EMAIL }}
          password: ${{ secrets.JIRA_API_TOKEN }}
          customHeaders: '{"Content-Type": "application/json"}'

      - name: Install jq
        run: sudo apt-get install jq
        if: steps.search_for_assignee.outcome == 'success'

      - name: Retrieve user list from search
        id: user_list_from_search
        if: steps.search_for_assignee.outcome == 'success'
        run: |
          selected_user_id=$(echo '${{ steps.search_for_assignee.outputs.response }}' | jq -r 'if length > 0 then .[0].accountId else "empty" end')
          selected_user_name=$(echo '${{ steps.search_for_assignee.outputs.response }}' | jq -r 'if length > 0 then .[0].displayName else "empty" end')
          echo "selected_user_id=${selected_user_id}" >> $GITHUB_OUTPUT
          echo "selected_user_name=${selected_user_name}" >> $GITHUB_OUTPUT

      - name: Inform user existence
        if: steps.user_list_from_search.outputs.selected_user_id != 'empty'
        uses: port-labs/port-github-action@v1
        with:
          clientId: ${{ secrets.PORT_CLIENT_ID }}
          clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
          operation: PATCH_RUN
          runId: ${{ fromJson(inputs.port_payload).context.runId }}
          logMessage: |
            User found 🥹 Assigning ticket ${{ fromJson(inputs.port_payload).context.entity }} to ${{ steps.user_list_from_search.outputs.selected_user_name }}... ⛴️

      - name: Inform user inexistence
        if: steps.user_list_from_search.outputs.selected_user_id == 'empty'
        uses: port-labs/port-github-action@v1
        with:
          clientId: ${{ secrets.PORT_CLIENT_ID }}
          clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
          operation: PATCH_RUN
          runId: ${{ fromJson(inputs.port_payload).context.runId }}
          logMessage: |
            User not found 😭 Skipping assignment... ⛴️

      - name: Assign ticket to selected user
        id: assign_ticket
        if: steps.user_list_from_search.outputs.selected_user_id != 'empty'
        uses: fjogeleit/http-request-action@v1
        with:
          url: "${{ secrets.JIRA_BASE_URL }}/rest/api/3/issue/${{ fromJson(inputs.port_payload).context.entity }}/assignee"
          method: "PUT"
          username: ${{ secrets.JIRA_USER_EMAIL }}
          password: ${{ secrets.JIRA_API_TOKEN }}
          customHeaders: '{"Content-Type": "application/json"}'
          data: '{"accountId": "${{ steps.user_list_from_search.outputs.selected_user_id }}"}'

      - name: Inform ticket has been assigned
        if: steps.assign_ticket.outcome == 'success'
        uses: port-labs/port-github-action@v1
        with:
          clientId: ${{ secrets.PORT_CLIENT_ID }}
          clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
          operation: PATCH_RUN
          link: ${{ secrets.JIRA_BASE_URL }}/browse/${{ fromJson(inputs.port_payload).context.entity }}
          runId: ${{ fromJson(inputs.port_payload).context.runId }}
          logMessage: |
            Jira issue has been assigned to ${{ steps.user_list_from_search.outputs.selected_user_name }}! ✅

Port Configuration

1. Head to the self-service page.
2. Click on the + New Action button.
3. Choose the Jira Issue blueprint and click Next.
4. Click on the {...} Edit JSON button.
5. Copy and paste the following JSON configuration into the editor.

Change status of a Jira ticket (Click to expand)

Modification Required

Make sure to replace <GITHUB_ORG> and <GITHUB_REPO> with your GitHub organization and repository names respectively.

{
  "identifier": "jiraIssue_change_jira_ticket_status",
  "title": "Change Jira ticket status and assignee",
  "icon": "Jira",
  "description": "Transition a ticket to another status.",
  "trigger": {
    "type": "self-service",
    "operation": "DAY-2",
    "userInputs": {
      "properties": {
        "status": {
          "icon": "DefaultProperty",
          "title": "Status",
          "type": "string",
          "enum": [
            "To Do",
            "In Progress",
            "Code Review",
            "Product Review",
            "Waiting For Prod",
            "Done"
          ],
          "enumColors": {
            "To Do": "lightGray",
            "In Progress": "bronze",
            "Code Review": "darkGray",
            "Product Review": "purple",
            "Waiting For Prod": "orange",
            "Done": "green"
          }
        },
        "assignee": {
          "type": "string",
          "title": "Assignee",
          "icon": "User",
          "format": "user"
        }
      },
      "required": [
        "status",
        "assignee"
      ],
      "order": [
        "status"
      ]
    },
    "blueprintIdentifier": "jiraIssue"
  },
  "invocationMethod": {
    "type": "GITHUB",
    "org": "<Enter GitHub organization>",
    "repo": "<Enter GitHub repository>",
    "workflow": "change_jira_ticket_status_and_assignee.yml",
    "workflowInputs": {
      "{{if (.inputs | has(\"ref\")) then \"ref\" else null end}}": "{{.inputs.\"ref\"}}",
      "{{if (.inputs | has(\"status\")) then \"status\" else null end}}": "{{.inputs.\"status\"}}",
      "{{if (.inputs | has(\"assignee\")) then \"assignee\" else null end}}": "{{.inputs.\"assignee\"}}",
      "port_payload": {
        "action": "{{ .action.identifier[(\"jiraIssue_\" | length):] }}",
        "resourceType": "run",
        "status": "TRIGGERED",
        "trigger": "{{ .trigger | {by, origin, at} }}",
        "context": {
          "entity": "{{.entity.identifier}}",
          "blueprint": "{{.action.blueprint}}",
          "runId": "{{.run.id}}"
        },
        "payload": {
          "entity": "{{ (if .entity == {} then null else .entity end) }}",
          "action": {
            "invocationMethod": {
              "type": "GITHUB",
              "org": "<Enter GitHub organization>",
              "repo": "<Enter GitHub repository>",
              "workflow": "change_jira_ticket_status_and_assignee.yml",
              "omitUserInputs": false,
              "omitPayload": false,
              "reportWorkflowStatus": true
            },
            "trigger": "{{.trigger.operation}}"
          },
          "properties": {
            "{{if (.inputs | has(\"status\")) then \"status\" else null end}}": "{{.inputs.\"status\"}}",
            "{{if (.inputs | has(\"assignee\")) then \"assignee\" else null end}}": "{{.inputs.\"assignee\"}}"
          },
          "censoredProperties": "{{.action.encryptedProperties}}"
        }
      }
    },
    "reportWorkflowStatus": true
  },
  "requiredApproval": false,
  "publish": true
}

6. Click Save.

Now you should see the Change Jira ticket status and assignee action in the self-service page. 🎉

Let's test it!

1. Head to the Self Service hub
2. Click on the Change Jira ticket status and assignee action
3. Choose the jira ticket you want to change the status and assignee for (In case you didn't install the Jira integration, it means you don't have any Jira tickets in Port yet, so you will need to create one manually in Port to test this action)
4. Select the new status
5. Enter the name of the assignee or their email address
6. Click on Execute
7. Done! wait for the ticket's status and assignee to be changed in Jira

Congrats 🎉 You've changed a ticket status and its assignee in Port 🔥

More Self Service Jira Actions Examples

• Report a bug in Jira using Port's self-service actions
• Open Jira issues with automatic labels
• Open/close JIRA issues for entities with violated scorecard rules
• Add a comment to a Jira ticket using Port's self-service actions