conventional-commits.yml

name: Check PR title

on:
  pull_request_target:
    types:
      - opened
      - reopened
      - edited
      - synchronize

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  check:
    name: conventional-pr-title:required
    runs-on: ubuntu-latest
    steps:
      # Conventional commit patterns:
      #   verb: description
      #   verb!: description of breaking change
      #   verb(scope): Description of change to $scope
      #   verb(scope)!: Description of breaking change to $scope
      # verb: feat, fix, ...
      # scope: refers to the part of code being changed.  E.g. " (accounts)" or " (accounts,canisters)"
      # !: Indicates that the PR contains a breaking change.
      - env:
          TITLE: ${{ github.event.pull_request.title }}
        run: |
          echo "PR title: $TITLE"
          if [[ "$TITLE" =~ ^(feat|fix|chore|build|ci|docs|style|refactor|perf|test)(\([-a-zA-Z0-9,]+\))?\!?\: ]]; then
              echo pass
          else
              echo "PR title does not match conventions"
              exit 1
          fi