@lmc-eu/conventional-changelog-lmc-github

LMC’s Conventional Changelog preset for GitHub repositories

Usage

Installation

NPM:

1npm i --dev @commitlint/cli @commitlint/config-conventional @lmc-eu/conventional-changelog-lmc-github

Yarn:

1yarn add --dev @commitlint/cli @commitlint/config-conventional @lmc-eu/conventional-changelog-lmc-github

Configuration

Linting

Create a commitlint.config.js file with the following contents:

1'use strict';
2
3module.exports = {
4  extends: ['@commitlint/config-conventional'],
5  parserPreset: '@lmc-eu/conventional-changelog-lmc-github',
6};

Changelog

In a package.json define following scripts:

1{
2  "scripts": {
3    "changelog": "conventional-changelog -p lmc-github -i CHANGELOG.md -s",
4    "changelog:origin": "conventional-changelog -p lmc-github -i CHANGELOG.md -s -r 0"
5  }
6}

For example see example changelog file