Skip to content

Commit

Permalink
docs(release): document __INVALID__ conventional commit type
Browse files Browse the repository at this point in the history
  • Loading branch information
llwt committed Feb 20, 2025
1 parent a94bc76 commit 193b437
Showing 1 changed file with 25 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -148,3 +148,28 @@ If you want to use custom, non-standard conventional commit types, you can defin
}
}
```

## Including Invalid Commits in the Changelog

Nx only includes commits in the changelog that match either the [default conventional commit types](https://github.com/nrwl/nx/blob/master/packages/nx/src/command-line/release/config/conventional-commits.ts) or types you've [added to your configuration](#defining-non-standard-commit-types).

You can configure Nx to include non-matching commits by adding the special **INVALID** type.

This can also be useful in cases where you don't use the Conventional Commits standard but still want a changelog to be generated with the contents of each commit message.

```json {% fileName="nx.json" %}
{
"release": {
"conventionalCommits": {
"types": {
"__INVALID__": {
"semverBump": "paths", // Note: the default is "none"
"changelog": {
"title": "Uncategorized changes"
}
}
}
}
}
}
```

0 comments on commit 193b437

Please sign in to comment.