release-it 15.0.0 → 15.1.1

package/README.md

@@ -35,9 +35,8 @@ environments running Node.js v10 and v12. Also see [CHANGELOG.md](./CHANGELOG.md
 
 ## Installation
 
-Although release-it is a **generic** release tool, installation requires npm. To use release-it, a `package.json` file
-is not required. The recommended way to install release-it also adds basic configuration. Answer one or two questions
-and it's ready:
+Although release-it is a **generic** release tool, most projects use it for projects with npm packages. The recommended
+way to install release-it uses npm and adds some minimal configuration to get started:
 
 ```bash
 npm init release-it
@@ -46,7 +45,7 @@ npm init release-it
 Alternatively, install it manually, and add the `release` script to `package.json`:
 
 ```bash
-npm install --save-dev release-it
+npm install -D release-it
 ```
 
 ```json
@@ -62,24 +61,33 @@ npm install --save-dev release-it
 }
 ```
 
-Now you can run `npm run release` from the command line (any release-it arguments behind the `--`):
+Now you can run `npm run release` from the command line (put release-it arguments behind the `-- `):
 
 ```bash
 npm run release
 npm run release -- minor --ci
 ```
 
-### Global usage
+### Global Installation
 
-Use release-it in any (non-npm) project, take it for a test drive, or install it globally:
+#### Using npx or npm
+
+Use npx to run release-it directly from anywhere:
 
 ```bash
-# Run release-it from anywhere (without installation)
 npx release-it
+```
 
-# Install globally and run from anywhere
-npm install --global release-it
-release-it
+Or use npm to install and run release-it globally:
+
+```bash
+npm install -g release-it
+```
+
+#### Using Homebrew
+
+```bash
+brew install release-it
 ```
 
 ## Usage
@@ -90,7 +98,7 @@ Release a new version:
 release-it
 ```
 
-You will be prompted to select the new version, and more prompts will follow based on your setup.
+You will be prompted to select the new version, and more prompts will follow based on your configuration.
 
 Run release-it from the root of the project to prevent potential issues.
 

package/lib/index.js

@@ -133,4 +133,4 @@ const runTasks = async (opts, di) => {
 
 export default runTasks;
 
-export { Plugin };
+export { Plugin, Config };

package/lib/plugin/git/Git.js

@@ -168,7 +168,8 @@ class Git extends GitBase {
 
   commit({ message = this.options.commitMessage, args = this.options.commitArgs } = {}) {
     const msg = format(message, this.config.getContext());
-    return this.exec(['git', 'commit', '--message', msg, ...fixArgs(args)]).then(
+    const commitMessageArgs = msg ? ['--message', msg] : [];
+    return this.exec(['git', 'commit', ...commitMessageArgs, ...fixArgs(args)]).then(
       () => this.setContext({ isCommitted: true }),
       err => {
         this.debug(err);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "15.0.0",
+  "version": "15.1.1",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -66,39 +66,39 @@
     "execa": "6.1.0",
     "form-data": "4.0.0",
     "git-url-parse": "11.6.0",
-    "globby": "13.1.1",
-    "got": "12.0.4",
-    "inquirer": "8.2.4",
+    "globby": "13.1.2",
+    "got": "12.1.0",
+    "inquirer": "9.0.0",
     "is-ci": "3.0.1",
     "lodash": "4.17.21",
     "mime-types": "2.1.35",
     "new-github-release-url": "2.0.0",
     "open": "8.4.0",
-    "ora": "6.1.0",
+    "ora": "6.1.2",
     "os-name": "5.0.1",
     "promise.allsettled": "1.0.5",
     "proxy-agent": "5.0.0",
     "semver": "7.3.7",
     "shelljs": "0.8.5",
-    "update-notifier": "5.1.0",
+    "update-notifier": "6.0.2",
     "url-join": "5.0.0",
     "wildcard-match": "5.1.2",
     "yargs-parser": "21.0.1"
   },
   "devDependencies": {
     "@octokit/request-error": "2.1.0",
-    "ava": "4.2.0",
-    "eslint": "8.14.0",
+    "ava": "4.3.0",
+    "eslint": "8.18.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-plugin-ava": "13.2.0",
     "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-prettier": "4.0.0",
+    "eslint-plugin-prettier": "4.1.0",
     "mock-fs": "5.1.2",
     "mock-stdio": "1.0.3",
-    "nock": "13.2.4",
+    "nock": "13.2.7",
     "nyc": "15.1.0",
-    "prettier": "2.6.2",
-    "sinon": "13.0.2",
+    "prettier": "2.7.1",
+    "sinon": "14.0.0",
     "strip-ansi": "7.0.1"
   },
   "engines": {

package/test/git.js

@@ -140,6 +140,20 @@ test.serial('should commit, tag and push with extra args', async t => {
   stub.restore();
 });
 
+test.serial('should amend commit without message if not provided', async t => {
+  const bare = mkTmpDir();
+  sh.exec(`git init --bare ${bare}`);
+  sh.exec(`git clone ${bare} .`);
+  gitAdd('line', 'file', 'Add file');
+  const options = { git: { commitArgs: ['--amend', '--no-edit', '--no-verify'] } };
+  const gitClient = factory(Git, { options });
+  const stub = sinon.stub(gitClient.shell, 'exec').resolves();
+  await gitClient.stage('package.json');
+  await gitClient.commit();
+  t.deepEqual(stub.secondCall.args[0], ['git', 'commit', '--amend', '--no-edit', '--no-verify']);
+  stub.restore();
+});
+
 test.serial('should commit and tag with quoted characters', async t => {
   const bare = mkTmpDir();
   sh.exec(`git init --bare ${bare}`);

package/test/github.js

@@ -198,7 +198,8 @@ test('should create new release for unreleased tag', async t => {
 });
 
 test('should release to enterprise host', async t => {
-  const github = factory(GitHub, { options: { git, github: { tokenRef } } });
+  const options = { git, github: { tokenRef, pushRepo: 'git://github.example.org:user/repo' } };
+  const github = factory(GitHub, { options });
   const exec = sinon.stub(github.shell, 'exec').callThrough();
   exec.withArgs('git remote get-url origin').resolves(`https://github.example.org/user/repo`);
   exec.withArgs('git config --get remote.origin.url').resolves(`https://github.example.org/user/repo`);
@@ -307,7 +308,7 @@ test.serial('should skip authentication and collaborator checks when running on
 
   t.is(authStub.callCount, 0);
   t.is(collaboratorStub.callCount, 0);
-  t.is(github.getContext('username'), 'webpro');
+  t.is(github.getContext('username'), process.env.GITHUB_ACTOR);
 
   authStub.restore();
   collaboratorStub.restore();

package/test/plugins.js

@@ -37,7 +37,7 @@ const getContainer = options => {
   };
 };
 
-test.serial.before(t => {
+test.before(t => {
   t.timeout(60 * 1000);
   sh.exec('npm link');
 });

package/test/tasks.interactive.js

@@ -59,6 +59,10 @@ const getHooks = plugins => {
   return hooks;
 };
 
+test.before(t => {
+  t.timeout(60 * 1000);
+});
+
 test.serial.beforeEach(t => {
   const bare = mkTmpDir();
   const target = mkTmpDir();