This extension helps you creating consistent changelogs. With many customization options you can look at the changelog however you want. Feel free to customize the icons and colors or try out flatten the tree structure or even change the date format.
The extension checks all folders in of your workspaces if a CHANGELOG.md (case-insensitive) file exists (include/exclude regexes are customizable). They are listet in the tree view by the name of folders where they are found.
When hovering over the tree items you get the options to add or edit items. Items can be deleted over the context menu.
Whenever you add or change an item, the corresponding changelog file will be updated immediately. The file is formatted according to the convention from keepachangelog.com.
By default, there is an attribution to this extension right below the title. There are configuration options to turn it into a markdown comment, change its position in the file or completely remove it. Please notice that my aim is to make changelogs on the internet more consistent and not to bother you with advertising my extension. 😊
If you have any ideas how this extension could be improved, feel free to open an issue or get in touch with me.
All keys starting with simpleChangelog.
| Settings key | Type | Default Value | Description |
|---|---|---|---|
| icons.color.enabled | boolean | true |
Enable/disable color on icons in changelog. |
| icons.addition.icon | string | add |
The icon for the Additions section. |
| icons.addition.color | string | charts.blue |
The color of the Additions icon. |
| icons.change.icon | string | edit |
The icon for the Changes section. |
| icons.change.color | string | charts.yellow |
The color of the Changes icon. |
| icons.deprecation.icon | string | discard |
The icon for the Deprecations section. |
| icons.deprecation.color | string | charts.purple |
The color of the Deprecations icon. |
| icons.fix.icon | string | debug |
The icon for the Fixes section. |
| icons.fix.color | string | charts.green |
The color of the Fixes icon. |
| icons.removal.icon | string | circle-slash |
The icon for the Removals section. |
| icons.removal.color | string | charts.red |
The color of the Removals icon. |
| icons.securityChange.icon | string | warning |
The icon for the Security Changes section. |
| icons.securityChange.color | string | charts.orange |
The color of the Security Changes icon. |
| icons.item.icon | string | circle-filled |
The icon for the changelog items. |
| icons.item.enabled | boolean | false |
Enable/disable type icons on items. |
| groupsOpenByDefault | boolean | true |
If set to true, groups are open by default when opening version. |
| searchIncludeRegex | string | /changelog.md/i |
The regex used to search workspace folders for changelog files. |
| searchExcludeRegex | string | /node_modules/ |
The regex used exlude folders in search for changelog files. |
| dateFormat | string | YYYY-MM-DD |
The date format. See Moment.js Documentation for more information. |
| attribution.visibility | visible | hidden | none |
visible |
Choose how the attribution to the extension should be displayed. |
| attribution.placement | top | bottom |
top |
Choose where the attribution to the extension should be displayed. |