semantic-pr.yml

---
name: Semantic PR Validation
on:
  pull_request_target:
    types:
    - opened
    - edited
    - synchronize
defaults:
  run:
    shell: bash
jobs:
  validate:
    runs-on: ubuntu-22.04
    permissions:
      contents: read # Needed for checking out the repository
      pull-requests: read # Needed for reading prs
    steps:
    - name: Validate Pull Request
      uses: amannn/action-semantic-pull-request@c3cd5d1ea3580753008872425915e343e351ab54 # v5.2.0
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        # Configure which types are allowed.
        # Default: https://github.com/commitizen/conventional-commit-types
        types: |
          feat
          fix
          build
          chore
          ci
          docs
          perf
          refactor
          revert
          style
          test
          deps
        scopes: |
          deps
        # Configure that a scope must always be provided.
        requireScope: false
        # When using "Squash and merge" on a PR with only one commit, GitHub
        # will suggest using that commit message instead of the PR title for the
        # merge commit, and it's easy to commit this by mistake. Enable this option
        # to also validate the commit message for one commit PRs.
        validateSingleCommit: true
        # yamllint disable-line rule:comments-indentation
        # Configure additional validation for the subject based on a regex.

        # This ensures the subject doesn't start with an uppercase character.
        subjectPattern: ^(?![A-Z]).+$
        # If `subjectPattern` is configured, you can use this property to override
        # the default error message that is shown when the pattern doesn't match.
        # 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 ensure that the subject
          doesn't start with an uppercase character.