semantic_pr_check.yml

name: "Verify Semantic PR Title"

on:
  pull_request:
    types:
      - opened
      - edited
      - synchronize
      - ready_for_review

permissions:
  pull-requests: read

jobs:
  validate_pr_title:
    name: Validate PR title
    runs-on: ubuntu-latest
    steps:
      - uses: amannn/action-semantic-pull-request@v5
        if: ${{ github.event.pull_request.draft == false }}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          # Configure which types are allowed (newline-delimited).
          # See: https://github.com/commitizen/conventional-commit-types/blob/master/index.json
          types: |
            fix
            Fix
            feat
            Feat
            docs
            Docs
            ci
            CI
            chore
            Chore
            build
            Build
            test
            Test

          # # We don't use scopes as of now
          # scopes: |
          #   core
          #   ui
          #   JIRA-\d+

          # Require capitalization for the first letter of the subject.
          subjectPattern: ^[A-Z].*$
          # The variables `subject` and `title` can be used within the message.
          subjectPatternError: |
            The subject "{subject}" found in the pull request title "{title}"
            didn't match the configured pattern. Please check the title against
            the naming rules. You can also use the [WIP] prefix to bypass this check.