Skip to content
check-square

GitHub Action

JIRA Check Action

v2 Latest version

JIRA Check Action

check-square

JIRA Check Action

Simple GitHub Action for checking that the pull request title has a JIRA issue prefixed

Installation

Copy and paste the following snippet into your .yml file.

              

- name: JIRA Check Action

uses: polytech-com/jira-check-action@v2

Learn more about this action in polytech-com/jira-check-action

Choose a version

jira-check-action

Simple GitHub Action for checking that the pull request title has a JIRA issue prefixed.

The prefixed JIRA issue on the pull request title must be created with capitalized letters and without any prefixed spaces (e.g. "JIRA-123 My Awesome Title") for uniformity. The check is a bit pendantic so it can be used for e.g. automated GitHub release notes with JIRA links. Please see the test.bats file for valid and invalid cases. The tests requires bats-core to be installed.

Usage

Below is an example GitHub Action file showing the usage.

name: ci

on:
  pull_request:
    branches:
      - main

jobs:
  check-jira-issue:
    runs-on: ubuntu-latest
    steps:
      - name: Check JIRA Issue
        uses: polytech-com/jira-check-action@v2