Skip to content

Commit

Permalink
Fix up docs re. new options
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Aug 15, 2021
1 parent 264443e commit bf19b4e
Showing 1 changed file with 26 additions and 24 deletions.
50 changes: 26 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,24 +24,6 @@ Options are passed verbatim to
and
[conventional-changelog-core](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core#api).

The `context` and/or `gitRawCommitsOpts` options can also be used and will be passed as the respective arguments to
`conventional-changelog-core`, for example:

```json
"plugins": {
"@release-it/conventional-changelog": {
"preset": "angular",
"infile": "CHANGELOG.md",
"context": {
"linkCompare": false
},
"gitRawCommitsOpts": {
"merges": true
},
}
}
```

### `preset`

Use one of:
Expand Down Expand Up @@ -103,21 +85,41 @@ 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.)

### `context`

Default value: `undefined`

This option will be passed as the second argument (`context`) to
[conventional-changelog-core](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core#context),
for example:

```json
"plugins": {
"@release-it/conventional-changelog": {
"context": {
"linkCompare": false
}
}
}
```

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

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

Expand Down

0 comments on commit bf19b4e

Please sign in to comment.