miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(core): add changelog render options on manage releases page (#22810)

Browse Source 
Add a "customize changelog output" section to describe the available
render options as described by in [this
file](https://github.com/nrwl/nx/blob/master/packages/nx/release/changelog-renderer/index.ts).

## Related Issue(s)
Fixes #22809
This commit is contained in:
Marcus Thelin 2024-05-30 15:53:18 +02:00 committed by GitHub
parent 063e3c9174
commit 7cbecf3bbf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/shared/features/manage-releases.md
View File

@ -57,6 +57,40 @@ The configuration lives in your `nx.json` file under the `"release"` section.
}
```
### Customize changelog output
Changelog render options can be passed as [an object](https://github.com/nrwl/nx/blob/master/packages/nx/release/changelog-renderer/index.ts) under `release.changelog.projectChangelogs.renderOptions` and `release.changelog.workspaceChangelog.renderOptions` in your `nx.json` file. Below are all options with their default values for the built-in changelog renderer.
```jsonc {% fileName="nx.json" %}
{
// ... more nx.json config
"release": {
"changelog": {
"projectChangelogs": {
"renderOptions": {
// Whether or not the commit authors should be added to the bottom of the changelog in a "Thank You" section.
"authors": true,
// Whether or not the commit references (such as commit and/or PR links) should be included in the changelog.
"commitReferences": true,
// Whether or not 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).
"versionTitleDate": true
}
},
"workspaceChangelog": {
"renderOptions": {
// Whether or not the commit authors should be added to the bottom of the changelog in a "Thank You" section.
"authors": true,
// Whether or not the commit references (such as commit and/or PR links) should be included in the changelog.
"commitReferences": true,
// Whether or not 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).
"versionTitleDate": true
}
}
}
}
}
```
## Using nx release subcommands independently
As explained above, `nx release` is a wrapper around the three main phases of a release.