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 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, installation requires npm. To use release-it, a `package.json` file
39
- is not required. The recommended way to install release-it also adds basic configuration. Answer one or two questions
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 --save-dev release-it
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 (any release-it arguments behind the `--`):
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 usage
71
+ ### Global Installation
73
72
 
74
- Use release-it in any (non-npm) project, take it for a test drive, or install it globally:
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
- # Install globally and run from anywhere
81
- npm install --global release-it
82
- release-it
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 setup.
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
@@ -133,4 +133,4 @@ const runTasks = async (opts, di) => {
133
133
 
134
134
  export default runTasks;
135
135
 
136
- export { Plugin };
136
+ export { Plugin, Config };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "release-it",
3
- "version": "15.0.0",
3
+ "version": "15.1.0-next.0",
4
4
  "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
5
5
  "keywords": [
6
6
  "build",
package/test/plugins.js CHANGED
@@ -37,7 +37,7 @@ const getContainer = options => {
37
37
  };
38
38
  };
39
39
 
40
- test.serial.before(t => {
40
+ test.before(t => {
41
41
  t.timeout(60 * 1000);
42
42
  sh.exec('npm link');
43
43
  });
@@ -59,6 +59,10 @@ const getHooks = plugins => {
59
59
  return hooks;
60
60
  };
61
61
 
62
+ test.before(t => {
63
+ t.timeout(60 * 1000);
64
+ });
65
+
62
66
  test.serial.beforeEach(t => {
63
67
  const bare = mkTmpDir();
64
68
  const target = mkTmpDir();