/pull-request-name-linter-action

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

Primary LanguageTypeScriptMIT LicenseMIT

⚡️ Pull request name linter with commitlint ⚡️

build GitHub issues GitHub forks GitHub stars GitHub license Watch on GitHub Tweet

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
    - name: Install Dependencies
      run: npm install @commitlint/config-conventional
    - uses: JulienKode/pull-request-name-linter-action@v0.5.0

Note: make sure you install your dependencies that commitlint 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

image