Skip to content
Snippets Groups Projects
Commit 8b3749f0 authored by Daniel Dehennin's avatar Daniel Dehennin
Browse files

docs(commitlint): describe usage of the commitlint job

Verify formatting of all commit messages in the range
`$BASE_BRANCH..$CI_COMMIT_SHA`.

USAGE
=====

include:
  - project: EOLE/infra/ci-tools
    ref: stable
    file: /templates/Rules.yaml
  - project: EOLE/infra/ci-tools
    ref: stable
    file: /templates/Lint/Commitlint.yaml

stages:
  - lint

OPTIONAL VARIABLES
==================

- `BASE_BRANCH`: name of the referrence branch, defaults to
  `${CI_DEFAULT_BRANCH}`
- `COMMITLINT_IMAGE`: name of the `commitlint` docker image to use

REQUIREMENTS
============

- The `.not-on-stable` rules template
- A `lint` stage must be present in your pipeline or it must be
  overriden by the extending job to feet your need.

USED CI VARIABLES
=================

- `CI_COMMIT_SHA`
- `CI_DEFAULT_BRANCH`
parent 612dc3ea
No related branches found
No related tags found
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment