Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 1.14 KB

README.md

File metadata and controls

60 lines (39 loc) · 1.14 KB
Raw

Issuer

GitHub Action for adding a link to issue on PR description from PR title

Inputs

github_token

string

Required. GitHub Token from action context

host

string

Required. Issue tracking host URL

title

string

Optional. Default to ### Issuer

verify

boolean

Optional. Default to false, indicates weather the action should validate the PR title

ignore_label

string

Optional. Default to -issuer, if validate set to true, when label set, the action will skip verification

Verifier

The Action can also verify the Pull-request title:

  • It will check that the Title includes an issue
  • It will check that the structure of the title follow a proper format CODE-XXX [, CODE-XXX]: Title
  • It can be skipped by using the ignore_label

Usage Example

name: Issue tracking
jobs:
  issue-tracking:
    name: Issue tracking
    runs-on: ubuntu-latest
    steps:
      - uses: zattoo/issuer@v2
        with:
          github_token: ${{github.token}}
          host: 'https://atlassian.net/browse/'
          title: '### Tickets'
          verify: true,
          ignore_label: '-verify'