An easy way to create your changelog file
News fragments is a plugin for release-it that helps you to generate a changelog file.
Basically, you need to specify a folder to be your center of fragments that will generate a custom changelog when released. After that, you'll create files with the desired extension with quick messages inside that folder to better understand what will come up on the new version of your software.
In release-it config at package.json
, create a news-fragments
key-pair to override the default config - e.g.
"plugins": {
"news-fragments": {}
}
{
"changelogFile": "CHANGELOG.md",
"changelogDateFormat": "YYYY-MM-DD",
"changelogTemplate": changelogTemplate,
"fragmentsFolder": "fragments",
"fragmentsTypes": [
{ "title": "Features", "extension": "feature" },
{ "title": "Bugfixes", "extension": "bugfix" },
{ "title": "Documentation", "extension": "doc" },
{ "title": "Deprecations and Removals", "extension": "removal" },
{ "title": "Misc", "extension": "misc" }
]
}
# [{{newVersion}}] - ({{bumpDate}})
{{#fragments}}
## {{title}}
{{#each fragmentEntries}}
* {{this}}
{{/each}}
{{/fragments}}
See this plugin in action by checking our CHANGELOG.md
news-fragments --help