release-it 15.0.0-esm.6 → 15.1.0

package/README.md

@@ -20,6 +20,11 @@ system, and hooks to execute any command you need to test, build, and/or publish
 [![Action Status](https://github.com/release-it/release-it/workflows/Cross-OS%20Tests/badge.svg)](https://github.com/release-it/release-it/actions)
 [![npm version](https://badge.fury.io/js/release-it.svg)](https://www.npmjs.com/package/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
@@ -30,9 +35,8 @@ system, and hooks to execute any command you need to test, build, and/or publish
 
 ## 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
@@ -41,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
@@ -57,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
+
+#### Using npx or npm
 
-Use release-it in any (non-npm) project, take it for a test drive, or install it globally:
+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
@@ -85,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.
 
@@ -156,7 +169,8 @@ remote.
 ## GitHub Releases
 
 GitHub projects can have releases attached to Git tags, containing release notes and assets. There are two ways to add
-[GitHub releases](https://help.github.com/articles/creating-releases) in your release-it flow:
+[GitHub releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases) in your
+release-it flow:
 
 1. Automated (requires a `GITHUB_TOKEN`)
 2. Manual (using the GitHub web interface with pre-populated fields)
@@ -326,29 +340,22 @@ While mostly used as a CLI tool, release-it can be used as a dependency to integ
 - [antonmedv/fx](https://github.com/antonmedv/fx)
 - [blockchain/blockchain-wallet-v4-frontend](https://github.com/blockchain/blockchain-wallet-v4-frontend)
 - [callstack/linaria](https://github.com/callstack/linaria)
+- [callstack/react-native-paper](https://github.com/callstack/react-native-paper)
 - [ember-cli/ember-cli](https://github.com/ember-cli/ember-cli)
-- [metalsmith/metalsmith](https://github.com/metalsmith/metalsmith)
-- [react-native-paper](https://github.com/callstack/react-native-paper)
 - [js-cookie/js-cookie](https://github.com/js-cookie/js-cookie)
-- [saleor/saleor](https://github.com/saleor/saleor)
+- [metalsmith/metalsmith](https://github.com/metalsmith/metalsmith)
 - [mozilla/readability](https://github.com/mozilla/readability)
 - [redis/node-redis](https://github.com/redis/node-redis)
+- [saleor/saleor](https://github.com/saleor/saleor)
 - [shipshapecode/shepherd](https://github.com/shipshapecode/shepherd)
+- [StevenBlack/hosts](https://github.com/StevenBlack/hosts)
 - [swagger-api/swagger-ui](https://github.com/swagger-api/swagger-ui) +
   [swagger-editor](https://github.com/swagger-api/swagger-editor)
-- [StevenBlack/hosts](https://github.com/StevenBlack/hosts)
 - [tabler/tabler](https://github.com/tabler/tabler) + [tabler-icons](https://github.com/tabler/tabler-icons)
 - [youzan/vant](https://github.com/youzan/vant)
 - [Repositories that depend on release-it](https://github.com/release-it/release-it/network/dependents)
 - GitHub search for [filename:.release-it.json](https://github.com/search?q=filename%3A.release-it.json)
 
-## Resources
+## License
 
-- [semver.org](https://semver.org)
-- [GitHub Help](https://docs.github.com) (→
-  [About Releases](https://docs.github.com/free-pro-team@latest/github/administering-a-repository/about-releases))
-- [npm Blog: Publishing what you mean to publish](https://blog.npmjs.org/post/165769683050/publishing-what-you-mean-to-publish)
-- [npm Documentation: package.json](https://docs.npmjs.com/cli/v6/configuring-npm/package-json)
-- [Prereleases and npm](https://medium.com/@mbostock/prereleases-and-npm-e778fc5e2420)
-- [Glob Primer (node-glob)](https://github.com/isaacs/node-glob#glob-primer) (release-it uses
-  [globby](https://github.com/sindresorhus/globby#readme))
+[MIT](./LICENSE)

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-esm.6",
+  "version": "15.1.0",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -66,9 +66,9 @@
     "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.3",
+    "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",
@@ -87,18 +87,18 @@
   },
   "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",
     "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`);

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();