mirror of https://github.com/wagoid/commitlint-github-action.git synced 2025-11-07 08:06:54 +00:00

Wagner Santos 33f8aa30dd fix: revert action to use debian image

Somehow when using alpine image, github actions was not running the entrypoint

2019-10-04 00:47:40 -03:00

1.5 KiB

Raw Blame History

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/commitlint-github-action@v1.1.0

Inputs

`configFile`

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

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.

1.5 KiB Raw Blame History