Skip to content

Commitlint

The commitlint command will lint your commits to the conventional commit standard.

conventional-tools commitlint

There are two levels of linting errors and warnings. Errors will return a error response but warnings will not. This is so you can still commit if your commits have warnings. Below is an example out put from the above command.

conventional-tools commitlint

fix(no): make it actually work

⚠ references may not be empty
✖ scope must be one of [core, api, web, ios, release]

You can disable warnings my using the level flag. This will not show you warnings in your output

conventional-tools commitlint -l1

fix(no): make it actually work

✖ scope must be one of [core, api, web, ios, release]

Types

Commit types are hard coded and cannot be changed. The following commit types must be used. The ensures changelogs and semantic visioning can be used correctly.

  • build: Changes that affect the build system or external dependencies
  • ci: Changes to our CI configuration files and scripts
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • improvement: A improvement to an existing feature
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • revert: For when your reverting commits with git
  • style: Changes that do not affect the meaning of the code (white-space, formatting, etc)
  • test: Adding missing tests or correcting existing tests

Scopes

Scopes can be add pre project defined in your config file. The release scope is automatically added when linting to ensures the release commits make by conventional tools release commands

commit:
  scopes:
    - core
    - api
    - web
    - ios

Example Commits

fix(core): this is some fix

Some more into about the fix that can go into more detail

ref #123

style: phpcs

feat(web): add something cool

This add that cool thing that all of our user wanted

GitLab CI

You can run commitlint in your CI pipelines with the bellow example config.

lint:commits:
  stage: lint
  image: registry.k1.zportal.co.uk/practically-oss/conventional-tools:0.x
  script:
    - conventional-tools commitlint -l1

GitHub Actions

commits:
  name: Commitlint
  runs-on: ubuntu-latest
  steps:
    - name: Checkout
      uses: actions/checkout@v2
      with:
        fetch-depth: 1000

    - name: Lint commits
      uses: docker://registry.k1.zportal.co.uk/practically-oss/conventional-tools:0.x
      with:
        args: conventional-tools commitlint -l1

Git Hooks

You can use commitlint in the conventional tools built in git hooks. Below is an example config you can put in you .ctrc.yml

hooks:
  commit-msg:
    - conventional-tools commitlint -f HEAD~2