commitlint-github-action's Introduction

Commitlint Github Action

Lints Pull Request commits with commitlint

Usage

Create a github workflow in the .github folder, e.g. .github/workflows/commitlint.yml:

name: Commitlint
on: [pull_request]

jobs:
  lint:
    runs-on: ubuntu-latest
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    steps:
      - uses: actions/checkout@v1
      - uses: wagoid/[email protected]

Alternatively, you can run on other event types such as on: [push]. In that case the action will lint the current commit instead of linting all commits from a pull request.

Inputs

`configFile`

The path to your commitlint config file. Default commitlint.config.js.

`firstParent`

When set to true, we follow only the first parent commit when seeing a merge commit.

This helps to ignore errors in commits that were already present in your default branch (e.g. master) before adding conventional commit checks. More info in git-log docs.

Default true

About `extends` in your config file

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:

If you have a custom shared config that lies in a private registry, let us know! We will be happy to cover this case if necessary.

Recommend Projects

mj-hd / commitlint-github-action Goto Github PK