Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Jun 6, 2021
1 parent 33f860b commit 1a91bb6
Showing 1 changed file with 38 additions and 10 deletions.
48 changes: 38 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This plugin will provide the recommended bump to release-it, and update the chan
npm install --save-dev @release-it/conventional-changelog
```

## Config
## Configuration

In the [release-it](https://github.com/release-it/release-it) config, for example:

Expand All @@ -19,7 +19,26 @@ In the [release-it](https://github.com/release-it/release-it) config, for exampl
}
```

...or another example:
Options are passed verbatim to
[conventional-recommended-bump](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-recommended-bump#readme)
and
[conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog#readme).

### `preset`

Use one of:

- `angular`
- `atom`
- `codemirror`
- `ember`
- `eslint`
- `express`
- `jquery`
- `jscs`
- `jshint`

Use an object with `name` and `types` to use a custom preset, such as conventional commits:

```json
"plugins": {
Expand All @@ -43,14 +62,23 @@ In the [release-it](https://github.com/release-it/release-it) config, for exampl
}
```

- Omit the `infile` at will. If set, but the file does not exist yet, it's created with the full history.
- Please find the
[list of available presets](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages)
(`angular`, `ember`, etc).
- Options are passed verbatim to
[conventional-recommended-bump](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-recommended-bump#readme)
and
[conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog#readme).
### `infile`

Default value: `undefined`

- Set a filename as `infile` to write the changelog to. If this file does not exist yet, it's created with the full
history.
- When `infile` is not set, the changelog generated by this plugin will still be used as release notes for e.g.
[GitHub Releases](https://github.com/release-it/release-it/blob/master/docs/github-releases.md).

### `ignoreRecommendedBump`

Default value: `false`

Use `true` to ignore the recommended bump, and use the version provided by release-it (command line argument or prompt).

(Note that the changelog preview shows the recommended bump, as the desired version isn't known yet. The `infile` will
have the correct version.)

## GitHub Actions

Expand Down

0 comments on commit 1a91bb6

Please sign in to comment.