Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
hyoban committed Apr 12, 2024
1 parent 0cfe3b1 commit 3c5c8ee
Showing 1 changed file with 20 additions and 19 deletions.
39 changes: 20 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,24 @@

Run [release-it](https://github.com/release-it/release-it) with [pnpm](https://pnpm.io).

## Requirements

- [ ] use pnpm and set [packageManager](https://nodejs.org/api/packages.html#packagemanager) in `package.json` correctly
- [ ] use [Conventional Commits](https://www.conventionalcommits.org) and follow [Semantic Versioning](https://semver.org)
- [ ] prefer to add a `v` prefix to the tag name (e.g. `v1.2.3`)

## What it does

1. Disable built-in `npm`, `version`, `github` plugins
1. Provide recommended version automatically (code and idea from [conventional-changelog](https://github.com/release-it/conventional-changelog))
1. support [preMajor](https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/master/versions/2.2.0/README.md#premajor-boolean) option
1. When you are not in CI, it will use [bumpp](https://github.com/antfu/bumpp) for the next version
1. Bump all packages to the new version
1. Run `pnpm -r publish --access public --no-git-checks` ([pnpm publish](https://pnpm.io/cli/publish))
1. appendix `--tag {tag}` if it's a prerelease
1. Run `npx changelogithub` for GitHub release ([changelogithub](https://github.com/antfu/changelogithub))
1. You can disable it by setting `disableRelease` to `true` in `.release-it.json`

## Install

```sh
Expand All @@ -21,12 +39,13 @@ 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.
Check files content at [.release-it.json](./src/bin/release-it.txt) and [.github/workflows/release.yml](./src/bin/release.txt)

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

> [!NOTE]
> [!TIP]
> guard with [should-semantic-release](https://github.com/JoshuaKGoldberg/should-semantic-release)
## Usage
Expand All @@ -49,24 +68,6 @@ Choose a pre-release tag instead of the default `beta`
release-it --preRelease=alpha
```

## Requirements

- [ ] use pnpm and set [packageManager](https://nodejs.org/api/packages.html#packagemanager) in `package.json` correctly
- [ ] use [Conventional Commits](https://www.conventionalcommits.org) and follow [Semantic Versioning](https://semver.org)
- [ ] prefer to add a `v` prefix to the tag name (e.g. `v1.2.3`)

## What it does

1. Disable built-in `npm`, `version`, `github` plugins
1. Provide recommended version automatically (code and idea from [conventional-changelog](https://github.com/release-it/conventional-changelog))
1. support [preMajor](https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/master/versions/2.2.0/README.md#premajor-boolean) option
1. When you are not in CI, it will use [bumpp](https://github.com/antfu/bumpp) for the next version
1. Bump all packages to the new version
1. Run `pnpm -r publish --access public --no-git-checks` ([pnpm publish](https://pnpm.io/cli/publish))
1. appendix `--tag {tag}` if it's a prerelease
1. Run `npx changelogithub` for GitHub release ([changelogithub](https://github.com/antfu/changelogithub))
1. You can disable it by setting `disableRelease` to `true` in `.release-it.json`

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/release-it-pnpm?style=flat&colorA=080f12&colorB=1fa669
Expand Down

0 comments on commit 3c5c8ee

Please sign in to comment.