You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## Current Behavior
Documentation is missing
## Expected Behavior
Documentation should be there...
---------
Co-authored-by: Isaac Mann <[email protected]>
(cherry picked from commit 7611671)
The default changelog renderer for `nx release` generates a changelog entry for each released project similar to the following:
4
+
5
+
```md
6
+
## 7.9.0 (2024-05-13)
7
+
8
+
### 🚀 Features
9
+
10
+
- **rule-tester:** check for missing placeholder data in the message ([#9039](https://github.com/typescript-eslint/typescript-eslint/pull/9039))
11
+
12
+
### ❤️ Thank You
13
+
14
+
- Kirk Waiblinger
15
+
- Sheetal Nandi
16
+
- Vinccool96
17
+
```
18
+
19
+
## Include All Metadata
20
+
21
+
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 three options are true by default:
22
+
23
+
```json
24
+
{
25
+
"release": {
26
+
"changelog": {
27
+
"projectChangelogs": {
28
+
"renderOptions": {
29
+
"authors": true,
30
+
"commitReferences": true,
31
+
"versionTitleDate": true
32
+
}
33
+
}
34
+
}
35
+
}
36
+
}
37
+
```
38
+
39
+
#### `authors`
40
+
41
+
Whether the commit authors should be added to the bottom of the changelog in a "Thank You" section. Defaults to `true`.
42
+
43
+
#### `commitReferences`
44
+
45
+
Whether the commit references (such as commit and/or PR links) should be included in the changelog. Defaults to `true`.
46
+
47
+
#### `versionTitleDate`
48
+
49
+
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`.
50
+
51
+
## Remove All Metadata
52
+
53
+
If you prefer a more minimalist changelog, you can set all the options to false, like this:
54
+
55
+
```json
56
+
{
57
+
"release": {
58
+
"changelog": {
59
+
"projectChangelogs": {
60
+
"renderOptions": {
61
+
"authors": false,
62
+
"commitReferences": false,
63
+
"versionTitleDate": false
64
+
}
65
+
}
66
+
}
67
+
}
68
+
}
69
+
```
70
+
71
+
Which will generate a changelog that looks similar to the following:
72
+
73
+
```md
74
+
## 7.9.0
75
+
76
+
### 🚀 Features
77
+
78
+
- **rule-tester:** check for missing placeholder data in the message
0 commit comments