hokify / pull-request-name-linter-action

⚡️ Lint pull request name with commit lint. This is useful if you squash merge your pull requests ⚡️

⚡️ Pull request name linter with commitlint ⚡️

---

GitHub action to automatically lint pull request name with commitlint. This is useful if squash merge your pull request for example.

Note: If you are looking to lint the commits of your pull request with commitlint you can use commitlint-github-action

This package are using the commitlint 11 version

Configuration

Usage

Create .github/workflows/pr-name.yml

Create a workflow (eg: .github/workflows/pr-name.yml see Creating a Workflow file). Here is an example of configuration

name: pr-name-linter
on:
  pull_request:
    types: ['opened', 'edited', 'reopened', 'synchronize']

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - uses: JulienKode/pull-request-name-linter-action@v0.2.0

About extends in your config file

(copied from https://github.com/wagoid/commitlint-github-action/blob/master/README.md ;-), as this also applies to this action. thanks!) This is a Docker action, and was made like this so that you can run it with minimum setup, regardless of your repo's environment. It comes packed with the most famous shared configurations that you can use in your commitlint config's extends field:

• @commitlint/config-angular
• @commitlint/config-conventional
• @commitlint/config-lerna-scopes
• @commitlint/config-patternplate
• conventional-changelog-lint-config-canonical
• commitlint-config-jira

Apart from the shared configurations that are included by default, you can also include extra dependencies for other configs and plugins that you want to use.

Example

If you want to see an example of usage you can checkout this repository: https://github.com/JulienKode/pull-request-name-linter-action-example