pr-title-check.yml

# From: https://levelup.gitconnected.com/enforcing-jira-ticket-formatting-in-github-pr-titles-and-commit-messages-78d9755568df
name: "PR Title Check"
on:
  pull_request:
    branches: 
      - dev
      - main
      - 'release/**'
      - 'hotfix/**'
    types: [opened, edited, synchronize]
  merge_group:
    branches:
      - dev

jobs:
  check-title:
    runs-on: ubuntu-latest
    steps:
    - name: Check PR title
      uses: actions/github-script@v6
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        script: |
          const payload = context.payload
          let prTitle
          if (payload.pull_request) {
            prTitle = payload.pull_request.title
          } else if (payload.merge_group && payload.merge_group.pull_requests?.length) {
            prTitle = payload.merge_group.pull_requests[0].title
          } else {
            core.setFailed('Cannot determine PR title for validation.')
          }
          const prTitleExpectedPattern = /(^LNK-\d+:\s)|(^TECH_DEBT:\s)|(^DOCS:\s)/g
          const prTitleMismatchError = 'Invalid PR title "' + prTitle + '"! Must begin with LNK-nnnn:<space> or TECH_DEBT:<space> or DOCS:<space>, e.g. LNK-1234: My PR title, or TECH_DEBT: My PR title or DOCS: My PR title'
          if (!prTitleExpectedPattern.test(prTitle)) {
            // Fail the workflow
            console.log(prTitleMismatchError)
            core.setFailed(prTitleMismatchError)
          } else {
            console.log('PR title format is correct.')
          }