Jira Ticket Transitioner

This action can move Jira issue to col of choice by event (e.g: move to IN REVIEW col when author requests review, move to IN PROGRESS if reviewer requests changes, move to QA if pr is merged).

Inputs

• configPath - path to yaml file providing connection and transition rules configuration
• jiraToken - API token to use with jira connection (alternative to setting it in the config file)
• githubToken - GitHub token to use for GitHub API operations (required for milestone synchronization)

Envionment variables

• JIRA_API_TOKEN - api token to use with jira connection - if no password is provided in yaml file this one will be used.
• GITHUB_TOKEN - automatically provided by github CI it will be used to read github context object and extract information about the events

config.yaml

config yaml is a yaml document describling connection params and transition rules. transition rules are processed sequentially and first rule that matches entirely is applied provided that current issue state allows such transition - if not transition is treated as not matching and next rule is applied.

see sample yaml config file

# regexp pattern to use for issue key matching (matched case insensitive) search will be done against pr TITLE and branch name. All found issues will be affected
issueKeyRegExp: "ST-[0-9]+"

connection:
  # host to connect to
  host: "stormideas.atlassian.net"
  # user name to acces jira 
  username: "[email protected]"
  # password or token for jira - note that if you don't want to keep whole config as file secret you can use jiraToken action parameter
  password: "***"

# GitHub connection configuration (optional)
github:
  # GitHub token for API operations (optional if provided via githubToken input)
  token: "***"

# Enable milestone synchronization (optional, default: false)
syncMilestones: true

# rules are list of condition to be met in order to apply transition to the ticket
rules:
  # this rule apply only if issue is in selected for development or in progress state
  - from:
      - "Selected for Development"
      - "In Progress"
   # transition to apply provided that give state allows such transition   
    transition: "In review"
    # on what action this rule should be applied - note that depending on the action other properties might not be defined
    on:
      # when action is pull request
      pull_request:
      # ... and targets develop
        targetBranches:
          - develop
      # ... and action is one of following    
        actions:
          - opened
          - reopened
          - synchronize
      # ... and is not a draft    
        draft: false
      # .. and is not yet merged  
        merged: false
  - from:
      - "In review"
    transition: "to be dev tested"
    on:
      pull_request:
        targetBranches:
          - develop
        actions:
          - closed
        # all given labels must be found  
        withLabel:
          - "to be dev tested"
        # none of given labels mus be found  
        withoutLabel:
          - "work in progress"
        draft: false
        merged: true

  -
    from:
      - "In review"
    transition: "To be tested"
    on:
      pull_request:
        targetBranches:
          - develop
        actions:
          - closed
        draft: false
        merged: true

Milestone Synchronization

When syncMilestones is enabled in the config, the action will:

1. Check if the JIRA issue has a fix version (release) assigned
2. Look for a corresponding GitHub milestone with the same name
3. Create the milestone if it doesn't exist, including the release date from JIRA
4. Add the PR to the milestone

This ensures that GitHub PRs are properly linked to their corresponding JIRA releases, making it easier to track what changes are included in each release.

Documentation

• Development Guide - Information for developers working on this action
• Configuration Guide - Detailed configuration options
• Progress - Implementation progress and planned features
• Documentation Hub - Complete documentation