pr-lint.yml

name: "Lint PR"

on:
  pull_request:
    types:
      - opened
      - edited
      - synchronize
      - labeled
      - unlabeled
      - reopened

jobs:
  lintPr:
    runs-on: ubuntu-latest
    steps:
      # Please look up the latest version from
      # https://github.com/amannn/action-semantic-pull-request/releases
      - uses: amannn/action-semantic-pull-request@c3cd5d1ea3580753008872425915e343e351ab54
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          types: |
            feat
            fix
            chore
            refactor
            revert
            test
            perf
          scopes: |
            lib
            cli
            hcl2json
            hcl2cdk
            provider-generator
            tests
            examples
            readme
            docs
            release
            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

          subjectPatternError: |
            The subject "{subject}" found in the pull request title "{title}" does not match the required format.
            The format is "type(scope): message", supported types are feat, fix, chore, refactor, revert.
            The supported scopes are lib, cli, hcl2json, tests, examples, readme, docs, release, deps.
            Please stick to the format so that our automatic release process picks your commit up and
            your code makes it into the next release.