release-it 15.0.0 → 15.1.0-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -12
- package/lib/index.js +1 -1
- package/package.json +1 -1
- package/test/plugins.js +1 -1
- package/test/tasks.interactive.js +4 -0
package/README.md
CHANGED
|
@@ -35,9 +35,8 @@ environments running Node.js v10 and v12. Also see [CHANGELOG.md](./CHANGELOG.md
|
|
|
35
35
|
|
|
36
36
|
## Installation
|
|
37
37
|
|
|
38
|
-
Although release-it is a **generic** release tool,
|
|
39
|
-
|
|
40
|
-
and it's ready:
|
|
38
|
+
Although release-it is a **generic** release tool, most projects use it for projects with npm packages. The recommended
|
|
39
|
+
way to install release-it uses npm and adds some minimal configuration to get started:
|
|
41
40
|
|
|
42
41
|
```bash
|
|
43
42
|
npm init release-it
|
|
@@ -46,7 +45,7 @@ npm init release-it
|
|
|
46
45
|
Alternatively, install it manually, and add the `release` script to `package.json`:
|
|
47
46
|
|
|
48
47
|
```bash
|
|
49
|
-
npm install
|
|
48
|
+
npm install -D release-it
|
|
50
49
|
```
|
|
51
50
|
|
|
52
51
|
```json
|
|
@@ -62,24 +61,33 @@ npm install --save-dev release-it
|
|
|
62
61
|
}
|
|
63
62
|
```
|
|
64
63
|
|
|
65
|
-
Now you can run `npm run release` from the command line (
|
|
64
|
+
Now you can run `npm run release` from the command line (put release-it arguments behind the `-- `):
|
|
66
65
|
|
|
67
66
|
```bash
|
|
68
67
|
npm run release
|
|
69
68
|
npm run release -- minor --ci
|
|
70
69
|
```
|
|
71
70
|
|
|
72
|
-
### Global
|
|
71
|
+
### Global Installation
|
|
73
72
|
|
|
74
|
-
|
|
73
|
+
#### Using npx or npm
|
|
74
|
+
|
|
75
|
+
Use npx to run release-it directly from anywhere:
|
|
75
76
|
|
|
76
77
|
```bash
|
|
77
|
-
# Run release-it from anywhere (without installation)
|
|
78
78
|
npx release-it
|
|
79
|
+
```
|
|
79
80
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
81
|
+
Or use npm to install and run release-it globally:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
npm install -g release-it
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
#### Using Homebrew
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
brew install release-it
|
|
83
91
|
```
|
|
84
92
|
|
|
85
93
|
## Usage
|
|
@@ -90,7 +98,7 @@ Release a new version:
|
|
|
90
98
|
release-it
|
|
91
99
|
```
|
|
92
100
|
|
|
93
|
-
You will be prompted to select the new version, and more prompts will follow based on your
|
|
101
|
+
You will be prompted to select the new version, and more prompts will follow based on your configuration.
|
|
94
102
|
|
|
95
103
|
Run release-it from the root of the project to prevent potential issues.
|
|
96
104
|
|
package/lib/index.js
CHANGED
package/package.json
CHANGED
package/test/plugins.js
CHANGED