Configure Changelog Format
The default changelog renderer for nx release generates a changelog entry for each released project similar to the following:
1## 7.9.0 (2024-05-13)
2
3### 🚀 Features
4
5- **rule-tester:** check for missing placeholder data in the message ([#9039](https://github.com/typescript-eslint/typescript-eslint/pull/9039))
6
7### ❤️ Thank You
8
9- Kirk Waiblinger
10- Sheetal Nandi
11- Vinccool96
12Include All Metadata
There are a few options available to modify the default changelog renderer output. They can be applied to both workspaceChangelog and projectChangelogs in exactly the same way. All four options are true by default:
1{
2 "release": {
3 "changelog": {
4 "projectChangelogs": {
5 "renderOptions": {
6 "authors": true,
7 "mapAuthorsToGitHubUsernames": true,
8 "commitReferences": true,
9 "versionTitleDate": true
10 }
11 }
12 }
13 }
14}
15authors
Whether the commit authors should be added to the bottom of the changelog in a "Thank You" section. Defaults to true.
mapAuthorsToGitHubUsernames
If authors is enabled, controls whether or not to try to map the authors to their GitHub usernames using https://ungh.cc (from https://github.com/unjs/ungh) and the email addresses found in the commits. Defaults to true.
You should disable this option if you don't want to make any external requests to https://ungh.cc
commitReferences
Whether the commit references (such as commit and/or PR links) should be included in the changelog. Defaults to true.
versionTitleDate
Whether to include the date in the version title. It can be set to false to disable it, or true to enable with the default of (YYYY-MM-DD). Defaults to true.
Remove All Metadata
If you prefer a more minimalist changelog, you can set all the options to false, like this:
1{
2 "release": {
3 "changelog": {
4 "projectChangelogs": {
5 "renderOptions": {
6 "authors": false,
7 "mapAuthorsToGitHubUsernames": false,
8 "commitReferences": false,
9 "versionTitleDate": false
10 }
11 }
12 }
13 }
14}
15Which will generate a changelog that looks similar to the following:
1## 7.9.0
2
3### 🚀 Features
4
5- **rule-tester:** check for missing placeholder data in the message
6