Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 2.44 KB

README.md

File metadata and controls

44 lines (34 loc) · 2.44 KB

⚡️ Pull request name linter with commitlint ⚡️


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

GitHub action to automatically lint pull request name with commitlint.

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 12 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@v2
    - name: Install Dependencies
      run: npm install @commitlint/config-conventional
    - uses: cognitedata/[email protected]

Note: make sure you install your dependencies that commitlint use