conventional-commits-pr-action

Lints pull requests based on Conventional Commits v1.0.0.

Also has the ability to post a comment in the pull request conversation with examples.

Live examples:

• With pull request comment
• Without pull request comment

Usage

name: Pull Request Title Linter
on:
  pull_request:
    types:
      - opened
      - edited
      - reopened
      - synchronize
jobs:
  pr_lint:
    name: Lint pull request title
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write # post comments when 'comment' is true
    steps:
      - name: Lint pull request title
        uses: jef/conventional-commits-pr-action@v1

Inputs

bots_ignore

Optional A list of bots to ignore when linting the pull request title. Can be a comma-separated list.

comment

Optional Post a comment in the pull request conversation with examples.

Default value	true

Note

Commenting in the pull request conversation requires that the token is configured with the pull-requests permission.

token

Optional Access token to the repository.

Default value	${{ github.token }}

subject_pattern

Optional A regular expression pattern to validate the subject of the pull request title.

Default value	(empty)