release-it 14.14.0 → 14.14.1

package/CHANGELOG.md

@@ -0,0 +1,102 @@
+# Changelog
+
+This document lists breaking changes for each major release.
+
+See the GitHub Releases page for detailed changelogs:
+[https://github.com/release-it/release-it/releases](https://github.com/release-it/release-it/releases)
+
+## v14
+
+- Removed `global` property from plugins. Use `this.config[key]` instead.
+- Removed deprecated `npm.access` option. Set this in `package.json` instead.
+
+## v13
+
+- Dropped support for Node v8
+- Dropped support for GitLab v11.6 and lower.
+- Deprecated `scripts` are removed (in favor of [hooks](https://github.com/release-it/release-it#hooks)).
+- Removed deprecated `--non-interactive` (`-n`) argument. Use `--ci` instead.
+- Removed old `%s` and `[REV_RANGE]` syntax in command substitutions. Use `${version}` and `${latestTag}` instead.
+
+## v12
+
+- The `--follow-tags` argument for `git push` has been moved to the default configuration. This is only a breaking
+  change if `git.pushArgs` was not empty (it was empty by default).
+
+## v11
+
+- The custom `conventional-changelog` increment (e.g. `"increment": "conventional:angular"`) with additional script
+  configuration is replaced with a plugin. Please see
+  [conventional changelog](https://github.com/release-it/release-it/blob/master/docs/changelog.md#conventional-changelog)
+  how to use this plugin.
+- The `pkgFiles` option has been removed. If there's a need to bump other files than what `npm version` bumps, it should
+  be (part of) a plugin.
+- By default, the latest version was derived from the latest Git tag. From v11, if the repo has a `package.json` then
+  that `version` is used instead. The `use` option has been removed. Also see
+  [latest version](https://github.com/release-it/release-it#latest-version).
+- `scripts.changelog` has been moved to `git.changelog`
+
+## v10
+
+- Dropped support for Node v6
+- Deprecated options from v9 are removed, the `dist.repo` config in particular (also see
+  [distribution repository](https://github.com/release-it/release-it/blob/master/docs/recipes/distribution-repo.md) for
+  alternatives).
+- Drop the `--debug` flag. `DEBUG=release-it:* ...` still works.
+
+## v9
+
+There should be no breaking changes, but there have been major internal refactorings and an improved UI. A bunch of new
+features and bug fixes have been implemented. Last but not least, the configuration structure is changed significantly.
+For this (backwards compatible) change, deprecation warnings are shown, and configurations must be migrated with the
+next major release (v10).
+
+- All "command hooks" have been moved to `scripts.*`, and some have been renamed.
+- All `src.*` options have been moved to `git.*` (and `scripts.*`).
+- The `dist.repo` configuration and functionality has been removed.
+
+## v8
+
+- Drop the `--force` flag. It's only use was to move a Git tag.
+
+## v7
+
+- No longer adds untracked files to release commit. (#230)
+
+## v6
+
+- Default value for `requireCleanWorkingDir` is now `true` (previously: `false`). (#173)
+- Skip prompt (interactive) if corresponding task (non-interactive) is disabled. E.g. `npm.publish: false` will also not
+  show "publish" prompt.
+
+## v5
+
+- Drop support for Node v4.
+
+[Release notes for v5](https://github.com/release-it/release-it/releases/tag/5.0.0-beta.0)
+
+## v4
+
+- Use `shell.exec` for build commands by default (previously this required a `!` prefix).
+
+[Release notes for v4](https://github.com/release-it/release-it/releases/tag/4.0.0-rc.0)
+
+## v3
+
+- Configuration filename must be `.release-it.json` (previously `.release.json`).
+- Refactored configuration structure in this file (and the CLI arguments with it).
+
+[Release notes for v3](https://github.com/release-it/release-it/releases/tag/3.0.0)
+
+## v2
+
+- Build command is executed before git commit/push.
+- Configuration options are better organized. Most of them are backwards compatible with a deprecation notice.
+
+[Release notes for v2](https://github.com/release-it/release-it/releases/tag/2.0.0)
+
+## v1
+
+Initial major release.
+
+[Release notes for v1](https://github.com/release-it/release-it/releases/tag/1.0.0)

package/README.md

@@ -271,6 +271,14 @@ Use `--verbose` to log the output of the commands.
 For the sake of verbosity, the full list of hooks is actually: `init`, `beforeBump`, `bump`, `beforeRelease`, `release`
 or `afterRelease`. However, hooks like `before:beforeRelease` look weird and are usually not useful in practice.
 
+Note that arguments need to be quoted properly when used from the command line:
+
+```bash
+release-it --'hooks.after:release="echo Successfully released ${name} v${version} to ${repo.repository}."'
+```
+
+Using Inquirer.js inside custom hook scripts might cause issues (since release-it also uses this itself).
+
 ## Plugins
 
 Since v11, release-it can be extended in many, many ways. Here are some plugins:

package/lib/plugin/GitRelease.js

@@ -10,7 +10,7 @@ class GitRelease extends GitBase {
   getInitialOptions(options) {
     const baseOptions = super.getInitialOptions(...arguments);
     const git = options.git || defaultConfig.git;
-    const gitOptions = _.pick(git, ['tagName', 'pushRepo', 'changelog']);
+    const gitOptions = _.pick(git, ['tagName', 'tagMatch', 'pushRepo', 'changelog']);
     return _.defaults(baseOptions, gitOptions);
   }
 

package/lib/plugin/gitlab/GitLab.js

@@ -4,6 +4,7 @@ const got = require('got');
 const globby = require('globby');
 const FormData = require('form-data');
 const _ = require('lodash');
+const allSettled = require('promise.allsettled');
 const Release = require('../GitRelease');
 const { format, e } = require('../../util');
 const prompts = require('./prompts');
@@ -148,7 +149,7 @@ class GitLab extends Release {
       });
     });
     try {
-      await Promise.allSettled(requests).then(results => {
+      await allSettled(requests).then(results => {
         for (const result of results) {
           if (result.status === 'rejected') {
             throw e('Missing one or more milestones in GitLab. Creating a GitLab release will fail.', docs);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "14.14.0",
+  "version": "14.14.1",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -67,7 +67,7 @@
     "globby": "11.0.4",
     "got": "11.8.3",
     "import-cwd": "3.0.0",
-    "inquirer": "8.2.2",
+    "inquirer": "8.2.0",
     "is-ci": "3.0.1",
     "lodash": "4.17.21",
     "mime-types": "2.1.35",
@@ -76,7 +76,8 @@
     "ora": "5.4.1",
     "os-name": "4.0.1",
     "parse-json": "5.2.0",
-    "semver": "7.3.5",
+    "promise.allsettled": "1.0.5",
+    "semver": "7.3.6",
     "shelljs": "0.8.5",
     "update-notifier": "5.1.0",
     "url-join": "4.0.1",
@@ -88,17 +89,17 @@
   "devDependencies": {
     "@octokit/request-error": "2.1.0",
     "ava": "3.15.0",
-    "eslint": "8.12.0",
+    "eslint": "7.32.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-plugin-ava": "13.2.0",
-    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-import": "2.26.0",
     "eslint-plugin-prettier": "4.0.0",
     "markdown-toc": "1.2.0",
-    "mock-fs": "5.1.2",
+    "mock-fs": "4.14.0",
     "mock-stdio": "1.0.3",
     "nock": "13.2.4",
     "node-fetch": "2.6.7",
-    "prettier": "2.6.1",
+    "prettier": "2.6.2",
     "proxyquire": "2.1.3",
     "sinon": "13.0.1",
     "strip-ansi": "6.0.0"