๐Ÿ“ฆ hyoban / release-it-pnpm

๐Ÿ“„ config.mdx ยท 28 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28# Configuration

import { Callout } from "nextra/components";

<Callout>
  By default, the plugin will create a release on GitHub and doesn't create a
  changelog file.
</Callout>

|       Key        |   Type    |     Default     |            Description             |
| :--------------: | :-------: | :-------------: | :--------------------------------: |
| `disableRelease` | `boolean` |   `undefined`   | Do not create a release on GitHub. |
|     `inFile`     | `string`  |   `undefined`   |    Path to the changelog file.     |
|     `header`     | `string`  | `"# Changelog"` |   Header of the changelog file.    |

Example:

```json
{
  "plugins": {
    "release-it-pnpm": {
      "disableRelease": true,
      "inFile": "CHANGELOG.md"
    }
  }
}
```