Skip to content

Runs checks on the linked JIRA Issue of the Pull Request and leaves a comment with results

Notifications You must be signed in to change notification settings

rohitnb/jira-issue-checks-action

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JIRA Issue Checks Action

What does it do?

This action performs the following checks for the JIRA Issue provided in the input

Checks Performed:

  • Is the JIRA Issue assigned?
  • Is the JIRA Issue in the "In Progress" state?
  • Is the Sprint value updated?
  • Is the Fix Version updated?
  • Is the time logged?

Inputs

jira-issue

Required The JIRA issue number in the format XYZ-123. Default null

jira-token

Required The JIRA token. To set this token - form the string <jira-email-address>:<jira-api-token> and Base64 encode it. For example [email protected]:7h1s1smyJIRAt0k3n

ghtoken

Required The GitHub token Default null

jira-domain

Required The JIRA domain. Example: https://<company>.atlassian.net

Outputs

jira-assigned - Issue Assigned?

jira-sprint - Sprint value updated?

jira-fixversion - Fix version updated?

jira-timelogging - Time Logged?

jira-status - Issue Status is In Progress?

result - True if all checks passed.

Example usage

uses: rohitnb/jira-issue-checks-action@v1
with:
  jira-issue: 'XYZ-123'
  jira-token: ${{secrets.JIRA_TOKEN}}
  ghtoken: ${{secrets.GITHUB_TOKEN}}
  jira-domain: ${{secrets.JIRA_URL}}

Demo workflow file for Pull Requests

name: 'JIRA Issue Checks'
on: 
  pull_request:
    types: [opened,edited]

jobs:
  jira-issue-checks:
    runs-on: ubuntu-latest
    name: JIRA Issue checks
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Check if JIRA Issues meet policies
        id: jira-checks
        uses: rohitnb/jira-issue-checks-action@v2
        with:
          jira-issue: 'INTEG-2'
          jira-token: ${{secrets.JIRA_TOKEN}}
          ghtoken: ${{secrets.GITHUB_TOKEN}}
          jira-domain: ${{secrets.JIRA_URL}}
      - name: JIRA Issue Checks Results
        run: echo "JIRA Issue Checks Results - ${{ steps.jira-checks.outputs.result }}"

About

Runs checks on the linked JIRA Issue of the Pull Request and leaves a comment with results

Resources

Stars

Watchers

Forks

Packages

No packages published