Skip to content

Instantly share code, notes, and snippets.

@kerimdzhanov
Last active July 23, 2021 13:06
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save kerimdzhanov/1ad56e14af5e0497044aa7cff5cf25c3 to your computer and use it in GitHub Desktop.
Save kerimdzhanov/1ad56e14af5e0497044aa7cff5cf25c3 to your computer and use it in GitHub Desktop.
Conventional changelog config example
'use strict';
const config = require('conventional-changelog-conventionalcommits');
module.exports = config({
types: [
{ type: 'feat', section: 'Features' },
{ type: 'feature', section: 'Features' },
{ type: 'fix', section: 'Bug Fixes' },
{ type: 'perf', section: 'Performance Improvements' },
{ type: 'revert', section: 'Reverts' },
{ type: 'chore', section: 'Miscellaneous Chores', hidden: true },
{ type: 'test', section: 'Tests', hidden: true },
{ type: 'docs', section: 'Documentation', hidden: true },
{ type: 'style', section: 'Code Style Formatting', hidden: true },
{ type: 'refactor', section: 'Code Refactoring', hidden: true }
],
commitUrlFormat:'{{host}}/{{owner}}/{{repository}}/commits/{{hash}}',
compareUrlFormat: '{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}',
issuePrefixes: ['#'],
issueUrlFormat: '{{host}}/{{owner}}/{{repository}}/issues/{{id}}',
userUrlFormat: '{{host}}/users/{{user}}'
});
{
"devDependencies": {
"conventional-changelog-cli": "^2.1.0",
"conventional-changelog-conventionalcommits": "^4.4.0"
},
"scripts": {
"changelog": "conventional-changelog -n changelog-generator.config.js -i CHANGELOG.md -s"
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment