Skip to content

Commit

Permalink
Documentation for gitRawCommitsOpts (#30)
Browse files Browse the repository at this point in the history
  • Loading branch information
LastDragon-ru authored Aug 15, 2021
1 parent b1fab74 commit 264443e
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,24 @@ Use `true` to ignore the recommended bump, and use the version provided by relea
(Note that the changelog preview shows the recommended bump, as the desired version isn't known yet. The `infile` will
have the correct version.)

### `gitRawCommitsOpts`

Default value: `undefined`

Options for [`git-raw-commits`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-raw-commits#gitopts). For example, you can use the following option to include merge commits into changelog:

```json
{
"plugins": {
"@release-it/conventional-changelog": {
"gitRawCommitsOpts": {
"merges": null
}
}
}
}
```

## GitHub Actions

When using this plugin in a GitHub Action, make sure to set
Expand Down

0 comments on commit 264443e

Please sign in to comment.