danger-plugin-commitlint-gitlab


> This plugin checks a merge request title and commit messages to make sure they are well formatted and respect the commitlint/lint

Here are the conditions :

If MR sqash flag is true & multiple commits - title must be correct

If MR sqash flag is false & multiple commits - at least one commit must be correct

if single commit - first commit line must be correct

Rules

Usage

This plugin has been created especially for GITLAB and is supposed to be integrated in a CI job. It will not work in GitHub__

Install (with yarn or npm):

``sh
npm install --save-dev danger-plugin-commitlint-gitlab
`

At a glance:

If you dangerfile is located in a module-like folder, it will look like this :

`js
// dangerfile.js
import check from 'danger-plugin-conventional-commitlint-gitlab-mr'

import configConventional from '@commitlint/config-conventional';

(async function dangerReport() {

const commitlintConfig = {
severity: 'warn'
};
await check(configConventional.rules, commitlintConfig);
})();

`

If you get an isssue related to the import statement, try this:

In your project root folder:

- Create a sub folder
- Create a dangerfile.js inside of it

`js
const commitlint = require('danger-plugin-conventional-commitlint-gitlab-mr')
const configConventional = require('@commitlint/config-conventional')

;(async function dangerReport() {
const commitlintConfig = {
severity: 'fail',
}
await commitlint.default(configConventional.rules, commitlintConfig)
})()

`

-- You will need to install a few dependencies for the plugin to work :

- [commitlint/lint @8.3.5] (https://github.com/conventional-changelog/commitlint)

`sh
npm i commitlint/lint@8.3.5
`

- @commitlint/config-conventional @13.1.0

`sh
npm i commitlint/config-conventional@13.1.0
`

- install the plugin :

`sh
npm install --save-dev danger-plugin-commitlint-gitlab
`

$3

This modules supports debug module, set DEBUG environnement variable to danger-plugin:commitlint-gitlab

`bash
DEBUG=danger-plugin:commitlint-gitlab
``

Changelog

See the GitHub release history.

Contributing

See CONTRIBUTING.md.