Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
hyoban committed Mar 29, 2024
1 parent 415a1af commit 74a08d8
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,39 @@ Run [release-it](https://github.com/release-it/release-it) with [pnpm](https://p
ni -D release-it release-it-pnpm
```

Generate the recommended config, it will create or overwrite `.release-it.json` and `.github/workflows/release.yml` (guard with [should-semantic-release](https://github.com/JoshuaKGoldberg/should-semantic-release)) files.
You can also install it globally

```sh
npx release-it-pnpm
npm i -g release-it release-it-pnpm
```

Generate the recommended config, it will create or overwrite `.release-it.json` and `.github/workflows/release.yml` files.

```sh
release-it-pnpm
```

> [!NOTE]
> guard with [should-semantic-release](https://github.com/JoshuaKGoldberg/should-semantic-release)
## Usage

Manually decide the next version

```sh
npx release-it
release-it
```

Use recommended version

```sh
npx release-it --ci
release-it --ci
```

Choose a pre-release tag instead of the default `beta`

```sh
npx release-it --preRelease=alpha
release-it --preRelease=alpha
```

## Requirements
Expand Down

0 comments on commit 74a08d8

Please sign in to comment.