conventions.yml

name: "Enforce conventions"

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

permissions:
  pull-requests: read

jobs:
  lint-pr:
    name: Validate PR title follows Conventional Commits
    runs-on: ubuntu-latest
    steps:
      - uses: amannn/action-semantic-pull-request@0723387faaf9b38adef4775cd42cfd5155ed6017 # v5
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          # We may not need a scope on every commit (i.e. repo-level change).
          #
          # feat!: read config consistenly
          # feat(redis): support for clustering
          # chore(redis): update tests
          # fix(redis): trim connection string
          # ^    ^    ^
          # |    |    |__ Subject
          # |    |_______ Scope
          # |____________ Type: it can end with a ! to denote a breaking change.
          requireScope: false
          # Scope should be lowercase.
          disallowScopes: |
            [A-Z]+
          # ensures the subject doesn't start with an uppercase character.
          subjectPattern: ^(?![A-Z]).+$
          subjectPatternError: |
            The subject "{subject}" found in the pull request title "{title}"
            didn't match the configured pattern. Please ensure that the subject
            doesn't start with an uppercase character.
          types: |
            security
            fix
            feat
            docs
            chore
            deps