actions/commitlint-github-action
5
0
Fork 0
mirror of https://github.com/wagoid/commitlint-github-action.git synced 2025-11-07 16:06:56 +00:00
Code Activity Actions
Lints Pull Request commits with commitlint
17 commits 10 branches 102 tags 26 MiB
JavaScript 97.5%
Shell 1.6%
Dockerfile 0.9%
Find a file
Wagner Santos 85e9b073c0 docs: update CHANGELOG.md
2019-10-08 11:34:51 -03:00
.github/workflows test: add second commitlint check using yml file instead of js 2019-10-08 10:50:21 -03:00
.commitlintrc.yml test: add second commitlint check using yml file instead of js 2019-10-08 10:50:21 -03:00
.gitignore Initial commit 2019-10-01 18:29:56 -03:00
.prettierrc feat: add commitlint action 2019-10-04 00:17:29 -03:00
action.yml chore(release): bump version 2019-10-08 11:31:37 -03:00
CHANGELOG.md docs: update CHANGELOG.md 2019-10-08 11:34:51 -03:00
commitlint.config.js chore: add commitlint config file 2019-10-04 00:18:00 -03:00
Dockerfile perf: use smaller debian image 2019-10-08 11:31:42 -03:00
entrypoint.sh feat: add commitlint action 2019-10-04 00:17:29 -03:00
LICENSE Initial commit 2019-10-01 18:29:56 -03:00
package-lock.json docs: add changelog and script to generate it 2019-10-08 10:43:15 -03:00
package.json chore(release): bump version 2019-10-08 11:31:37 -03:00
README.md chore(release): bump version 2019-10-08 11:31:37 -03:00
run.js fix: do not call require in the config file to allow other file types 2019-10-08 10:50:21 -03:00

README.md

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.1

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.