release-it
Advanced tools
Comparing version 15.10.0 to 15.10.1
{ | ||
"name": "release-it", | ||
"version": "15.10.0", | ||
"version": "15.10.1", | ||
"description": "Generic CLI tool to automate versioning and package publishing related tasks.", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
118
README.md
@@ -23,15 +23,2 @@ # Release It! 🚀 | ||
## Announcement | ||
The latest major version is v15, supporting Node.js 14 and up (as Node.js v12 is EOL). Use release-it v14 for | ||
environments running Node.js v10 and v12. Also see [CHANGELOG.md](./CHANGELOG.md). | ||
## Links | ||
- See [CHANGELOG.md](./CHANGELOG.md) for major/breaking updates, and | ||
[releases](https://github.com/release-it/release-it/releases) for a detailed version history. | ||
- To **contribute**, please read [CONTRIBUTING.md](./.github/CONTRIBUTING.md) first. | ||
- Please [open an issue](https://github.com/release-it/release-it/issues/new) if anything is missing or unclear in this | ||
documentation. | ||
## Installation | ||
@@ -60,3 +47,3 @@ | ||
"devDependencies": { | ||
"release-it": "*" | ||
"release-it": "^15.10.0" | ||
} | ||
@@ -66,57 +53,36 @@ } | ||
Now you can run `npm run release` from the command line (put release-it arguments behind the `-- `): | ||
## Usage | ||
Run release-it from the root of the project using either `npm run` or `npx`: | ||
```bash | ||
npm run release | ||
npm run release -- minor --ci | ||
``` | ||
### Global Installation | ||
#### Using npx or npm | ||
Use npx to run release-it directly from anywhere: | ||
```bash | ||
npx release-it | ||
``` | ||
Or use npm to install and run release-it globally: | ||
You will be prompted to select the new version, and more prompts will follow based on your configuration. | ||
```bash | ||
npm install -g release-it | ||
``` | ||
## Yarn | ||
#### Using Homebrew | ||
Using Yarn? Please see the [npm section on Yarn](./docs/npm.md#yarn). | ||
```bash | ||
brew install release-it | ||
``` | ||
## Global Installation | ||
## Usage | ||
Per-project installation as shown above is recommended, but global installs are supported as well: | ||
Release a new version: | ||
- From npm: `npm install -g release-it` | ||
- From Homebrew: `brew install release-it` | ||
```bash | ||
release-it | ||
``` | ||
## GitHub Actions | ||
You will be prompted to select the new version, and more prompts will follow based on your configuration. | ||
Want to use release-it with GitHub Actions to fully automate the whole process? Enjoy this great walk-through: | ||
[How to use GitHub Actions & Release-It to Easily Release Your Code](https://www.youtube.com/watch?v=7pBcuT7j_A0) (by | ||
[David from Kodaps](https://twitter.com/KodapsAcademy)). | ||
Run release-it from the root of the project to prevent potential issues. | ||
→ See [Continuous Integration environments](./docs/ci.md) for more details. | ||
## Dry Runs | ||
Use `--dry-run` to show the interactivity and the commands it _would_ execute. | ||
→ See [Dry Runs](./docs/dry-runs.md) for more details. | ||
To print the next version without releasing anything, add the `--release-version` flag. | ||
To print the changelog without releasing anything, add the `--changelog` flag. | ||
## Configuration | ||
Out of the box, release-it has sane defaults, and [plenty of options](./config/release-it.json) to configure it. Most | ||
projects use a `.release-it.json` in the project root, or a `release-it` property in `package.json`. | ||
projects use a `.release-it.json` file in the project root, or a `release-it` property in `package.json`. | ||
@@ -204,3 +170,4 @@ → See [Configuration](./docs/configuration.md) for more details. | ||
overridden. To further customize the release notes for the GitHub or GitLab release, there's `github.releaseNotes` or | ||
`gitlab.releaseNotes`. Make sure any of these commands output the changelog to `stdout`. Plugins are available for: | ||
`gitlab.releaseNotes`. Make sure any of these commands output the changelog to `stdout`. Note that release-it by default | ||
is agnostic to commit message conventions. Plugins are available for: | ||
@@ -303,2 +270,20 @@ - GitHub and GitLab Releases | ||
## Dry Runs | ||
Use `--dry-run` to show the interactivity and the commands it _would_ execute. | ||
→ See [Dry Runs](./docs/dry-runs.md) for more details. | ||
To print the next version without releasing anything, add the `--release-version` flag. | ||
To print the changelog without releasing anything, add the `--changelog` flag. | ||
## Troubleshooting & debugging | ||
- With `release-it --verbose` (or `-V`), release-it prints the output of every user-defined [hook](#hooks). | ||
- With `release-it -VV`, release-it also prints the output of every internal command. | ||
- Use `NODE_DEBUG=release-it:* release-it [...]` to print configuration and more error details. | ||
Use `verbose: 2` in a configuration file to have the equivalent of `-VV` on the command line. | ||
## Plugins | ||
@@ -325,18 +310,2 @@ | ||
## Distribution repository | ||
Deprecated. Please see [distribution repository](./docs/recipes/distribution-repo.md) for more details. | ||
## Metrics | ||
In release-it v15, anonymous metrics have been removed from the codebase and no data is sent or stored anywhere. | ||
## Troubleshooting & debugging | ||
- With `release-it --verbose` (or `-V`), release-it prints the output of every user-defined [hook](#hooks). | ||
- With `release-it -VV`, release-it also prints the output of every internal command. | ||
- Use `NODE_DEBUG=release-it:* release-it [...]` to print configuration and more error details. | ||
Use `verbose: 2` in a configuration file to have the equivalent of `-VV` on the command line. | ||
## Use release-it programmatically | ||
@@ -370,4 +339,17 @@ | ||
## Legacy Node.js | ||
The latest major version is v15, supporting Node.js 14 and up (as Node.js v12 is EOL). Use release-it v14 for | ||
environments running Node.js v10 and v12. Also see [CHANGELOG.md](./CHANGELOG.md). | ||
## Links | ||
- See [CHANGELOG.md](./CHANGELOG.md) for major/breaking updates, and | ||
[releases](https://github.com/release-it/release-it/releases) for a detailed version history. | ||
- To **contribute**, please read [CONTRIBUTING.md](./.github/CONTRIBUTING.md) first. | ||
- Please [open an issue](https://github.com/release-it/release-it/issues/new) if anything is missing or unclear in this | ||
documentation. | ||
## License | ||
[MIT](./LICENSE) |
230551
349