release-it 14.6.3 → 14.10.0

package/README.md

@@ -4,19 +4,18 @@
 
 <img align="right" src="./docs/assets/release-it.svg?raw=true" height="280">
 
-- Execute test & build commands
 - Bump version (in e.g. `package.json`)
 - [Git commit, tag, push](#git)
+- Execute any (test or build) commands using [hooks](#hooks)
 - [Create release at GitHub](#github-releases) or [GitLab](#gitlab-releases)
 - [Generate changelog](#changelog)
 - [Publish to npm](#publish-to-npm)
 - [Manage pre-releases](#manage-pre-releases)
-- [Hooks](#hooks)
 - Extend with [plugins](#plugins)
 - Release from any [CI/CD environment](./docs/ci.md)
 
 Use release-it for version management and publish to anywhere with its versatile configuration, a powerful plugin
-system, and use hooks to execute any command you need to test, build, and/or publish your project.
+system, and hooks to execute any command you need to test, build, and/or publish your project.
 
 [![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)
@@ -32,8 +31,9 @@ system, and use hooks to execute any command you need to test, build, and/or pub
 
 ## Installation
 
-Although release-it is a **generic** release tool, installation requires npm. 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, 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:
 
 ```bash
 npm init release-it
@@ -86,39 +86,26 @@ Release a new version:
 release-it
 ```
 
-You will be prompted to select the new version, and more questions will follow based on your setup.
+You will be prompted to select the new version, and more prompts will follow based on your setup.
 
-Make sure to run release-it from the root of the project to prevent potential issues.
+Run release-it from the root of the project to prevent potential issues.
 
-## Dry Run
+## Dry Runs
 
-To show the interactivity and the commands it _would_ execute:
+Use `--dry-run` to show the interactivity and the commands it _would_ execute.
 
-```bash
-release-it --dry-run
-```
-
-Note: read-only commands are still executed (`$ ...`), while potentially writing/mutating commands are not (`! ...`):
+→ See [Dry Runs](./docs/dry-runs.md) for more details.
 
-```bash
-$ git rev-parse --git-dir
-.git
-! git add package.json
-! git commit --message="Release 0.8.3"
-```
+To print the next version without releasing anything, add the `--release-version` flag.
 
 ## Configuration
 
-Out of the box, release-it has sane defaults, and [plenty of options](./config/release-it.json) to configure it. Put
-(only) the options to override in a configuration file. This is where release-it looks for configuration:
+Out of the box, release-it has sane defaults, and [plenty of options](./config/release-it.json) to configure it. Most
+projects use a `.release-it.json` in the project root, or a `release-it` property in `package.json`.
 
-- `.release-it.json`
-- `.release-it.js` (or `.cjs`; export the configuration object: `module.exports = {}`)
-- `.release-it.yaml` (or `.yml`)
-- `.release-it.toml`
-- `package.json` (in the `release-it` property)
+→ See [Configuration](./docs/configuration.md) for more details.
 
-Use `--config` to use another path for the configuration file. An example `.release-it.json`:
+Here's a quick example `.release-it.json`:
 
 ```json
 {
@@ -131,48 +118,6 @@ Use `--config` to use another path for the configuration file. An example `.rele
 }
 ```
 
-Or in a `release-it` property in `package.json`:
-
-```json
-{
-  "name": "my-package",
-  "devDependencies": {
-    "release-it": "*"
-  },
-  "release-it": {
-    "github": {
-      "release": true
-    }
-  }
-}
-```
-
-Or use YAML in `.release-it.yml`:
-
-```yaml
-git:
-  requireCleanWorkingDir: false
-```
-
-Or TOML in `.release-it.toml`:
-
-```toml
-[hooks]
-"before:init" = "npm test"
-```
-
-Any option can also be set on the command-line, and will have highest priority. Example:
-
-```bash
-release-it minor --git.requireBranch=master --github.release
-```
-
-Boolean arguments can be negated by using the `no-` prefix:
-
-```bash
-release-it --no-npm.publish
-```
-
 ## Interactive vs. CI mode
 
 By default, release-it is **interactive** and allows you to confirm each task before execution:
@@ -200,6 +145,8 @@ Alternatively, a plugin can be used to override this (e.g. to manage a `VERSION`
   based on commit messages
 - [release-it-calver-plugin](https://github.com/casmith/release-it-calver-plugin) to use CalVer (Calendar Versioning)
 
+Add the `--release-version` flag to print the **next** version without releasing anything.
+
 ## Git
 
 Git projects are supported well by release-it, automating the tasks to stage, commit, tag and push releases to any Git
@@ -261,6 +208,16 @@ pre-releases. An example pre-release version is `2.0.0-beta.0`.
 
 → See [Manage pre-releases](./docs/pre-releases.md) for more details.
 
+## Update or re-run existing releases
+
+Use `--no-increment` to not increment the lastest version and update an existing tag/version.
+
+This may be helpful in some cases where the version was already incremented. Here's a few example scenarios:
+
+- To update or publish a draft GitHub Release for an existing Git tag.
+- Publishing to npm succeeded, but pushing the Git tag to the remote failed. Then use
+  `release-it --no-increment --no-npm` to skip the `npm publish` and try pushing the same Git tag again.
+
 ## Hooks
 
 Use script hooks to run shell commands at any moment during the release process (such as `before:init` or
@@ -339,13 +296,7 @@ Internally, release-it uses its own plugin architecture (for Git, GitHub, GitLab
 
 ## Distribution repository
 
-Some projects use a distribution repository. Generated files (such as compiled assets or documentation) can be
-distributed to a separate repository. Or to a separate branch, such as a `gh-pages`. Some examples include
-[shim repositories](https://github.com/components) and a separate
-[packaged Angular.js repository](https://github.com/angular/bower-angular) for distribution on npm and Bower.
-
-The `dist.repo` option was removed in v10, but similar setups can still be achieved. Please see the
-[distribution repository](./docs/recipes/distribution-repo.md) recipe for example configurations.
+Deprecated. Please see [distribution repository](./docs/recipes/distribution-repo.md) for more details.
 
 ## Metrics
 
@@ -354,9 +305,9 @@ Use `--disable-metrics` to opt-out of sending some anonymous statistical data to
 
 ## Troubleshooting & debugging
 
-- With `release-it --verbose` (or `-V`), release-it prints every custom script/hook and its output.
-- With `release-it -VV`, release-it also prints every internal command and its output.
-- Prepend `DEBUG=release-it:* release-it [...]` to print configuration and more error details.
+- With `release-it --verbose` (or `-V`), release-it prints the output of every user-defined [hook](#hooks).
+- With `release-it -VV`, release-it also prints the output of every internal command.
+- Use `DEBUG=release-it:* release-it [...]` to print configuration and more error details.
 
 Use `verbose: 2` in a configuration file to have the equivalent of `-VV` on the command line.
 

package/config/release-it.json

@@ -47,6 +47,7 @@
     "releaseNotes": null,
     "tokenRef": "GITLAB_TOKEN",
     "tokenHeader": "Private-Token",
+    "certificateAuthorityFile": null,
     "assets": null,
     "origin": null,
     "skipChecks": false

package/lib/cli.js

@@ -14,9 +14,9 @@ const helpText = `Release It! v${pkg.version}
   -h --help              Print this help
   -i --increment         Increment "major", "minor", "patch", or "pre*" version; or specify version [default: "patch"]
      --ci                No prompts, no user interaction; activated automatically in CI environments
-     --only-version      Prompt only version, no further interaction
+     --only-version      Prompt only for version, no further interaction
   -v --version           Print release-it version number
-  -v --release-version   Print version number to be released
+     --release-version   Print version number to be released
   -V --verbose           Verbose output (user hooks output)
   -VV                    Extra verbose output (also internal commands output)
 

package/lib/config.js

@@ -120,7 +120,7 @@ class Config {
   }
 
   get isReleaseVersion() {
-    return this.options['release-version'];
+    return Boolean(this.options['release-version']);
   }
 
   get isCollectMetrics() {

package/lib/plugin/factory.js

@@ -42,7 +42,7 @@ module.exports.getPlugins = async (config, container) => {
         const instance = new Plugin({ namespace, options: config.getContext(), container });
         debug({ namespace, options: instance.options });
         (await result).push(instance);
-        disabledPlugins.push(..._.intersection(pluginNames, _.castArray(Plugin.disablePlugin())));
+        disabledPlugins.push(..._.intersection(pluginNames, _.castArray(Plugin.disablePlugin(options))));
       }
       return result;
     },

package/lib/plugin/github/GitHub.js

@@ -19,7 +19,8 @@ const DEFAULT_RETRY_MIN_TIMEOUT = 1000;
 const parseErrormsg = err => {
   let msg = err;
   if (err instanceof Error) {
-    const { status, message, headers } = err;
+    const { status, message } = err;
+    const { headers } = err.response;
     msg = `${_.get(headers, 'status', status)} (${message})`;
   }
   return msg;
@@ -259,6 +260,7 @@ class GitHub extends Release {
   uploadAssets() {
     const { assets } = this.options;
     const { isReleased } = this.getContext();
+    const context = this.config.getContext();
     const { isDryRun } = this.config;
 
     this.log.exec('octokit repos.uploadReleaseAssets', assets, { isDryRun });
@@ -267,7 +269,9 @@ class GitHub extends Release {
       return true;
     }
 
-    return globby(assets).then(files => {
+    const patterns = _.castArray(assets).map(pattern => format(pattern, context));
+
+    return globby(patterns).then(files => {
       if (!files.length) {
         this.log.warn(`octokit repos.uploadReleaseAssets: did not find "${assets}" relative to ${process.cwd()}`);
       }

package/lib/plugin/gitlab/GitLab.js

@@ -3,6 +3,7 @@ const path = require('path');
 const got = require('got');
 const globby = require('globby');
 const FormData = require('form-data');
+const _ = require('lodash');
 const Release = require('../GitRelease');
 const { format, e } = require('../../util');
 const prompts = require('./prompts');
@@ -16,6 +17,10 @@ class GitLab extends Release {
     super(...args);
     this.registerPrompts(prompts);
     this.assets = [];
+    const { certificateAuthorityFile } = this.options;
+    this.certificateAuthorityOption = certificateAuthorityFile
+      ? { https: { certificateAuthority: fs.readFileSync(certificateAuthorityFile) } }
+      : {};
   }
 
   get client() {
@@ -28,7 +33,8 @@ class GitLab extends Release {
       headers: {
         'user-agent': 'webpro/release-it',
         [tokenHeader]: this.token
-      }
+      },
+      ...this.certificateAuthorityOption
     });
     return this._client;
   }
@@ -190,6 +196,7 @@ class GitLab extends Release {
   uploadAssets() {
     const { assets } = this.options;
     const { isDryRun } = this.config;
+    const context = this.config.getContext();
 
     this.log.exec('gitlab releases#uploadAssets', assets, { isDryRun });
 
@@ -197,7 +204,9 @@ class GitLab extends Release {
       return noop;
     }
 
-    return globby(assets).then(files => {
+    const patterns = _.castArray(assets).map(pattern => format(pattern, context));
+
+    return globby(patterns).then(files => {
       if (!files.length) {
         this.log.warn(`gitlab releases#uploadAssets: could not find "${assets}" relative to ${process.cwd()}`);
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "14.6.3",
+  "version": "14.10.0",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -58,24 +58,24 @@
   "license": "MIT",
   "dependencies": {
     "@iarna/toml": "2.2.5",
-    "@octokit/rest": "18.5.3",
+    "@octokit/rest": "18.6.0",
     "async-retry": "1.3.1",
     "chalk": "4.1.1",
     "cosmiconfig": "7.0.0",
     "debug": "4.3.1",
     "deprecated-obj": "2.0.0",
-    "execa": "5.0.0",
+    "execa": "5.1.1",
     "find-up": "5.0.0",
     "form-data": "4.0.0",
     "git-url-parse": "11.4.4",
-    "globby": "11.0.3",
+    "globby": "11.0.4",
     "got": "11.8.2",
     "import-cwd": "3.0.0",
-    "inquirer": "8.0.0",
+    "inquirer": "8.1.1",
     "is-ci": "3.0.0",
     "lodash": "4.17.21",
-    "mime-types": "2.1.30",
-    "ora": "5.4.0",
+    "mime-types": "2.1.31",
+    "ora": "5.4.1",
     "os-name": "4.0.0",
     "parse-json": "5.2.0",
     "semver": "7.3.5",
@@ -87,22 +87,22 @@
     "yargs-parser": "20.2.7"
   },
   "devDependencies": {
-    "@octokit/request-error": "2.0.5",
+    "@octokit/request-error": "2.1.0",
     "ava": "3.15.0",
     "codecov": "3.8.2",
-    "eslint": "7.26.0",
+    "eslint": "7.29.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-ava": "12.0.0",
-    "eslint-plugin-import": "2.22.1",
+    "eslint-plugin-import": "2.23.4",
     "eslint-plugin-prettier": "3.4.0",
     "markdown-toc": "1.2.0",
-    "mock-fs": "4.14.0",
+    "mock-fs": "5.0.0",
     "mock-stdio": "1.0.3",
-    "nock": "13.0.11",
+    "nock": "13.1.0",
     "nyc": "15.1.0",
-    "prettier": "2.2.1",
+    "prettier": "2.3.1",
     "proxyquire": "2.1.3",
-    "sinon": "10.0.1",
+    "sinon": "11.1.1",
     "strip-ansi": "6.0.0"
   },
   "engines": {

package/test/github.js

@@ -16,6 +16,7 @@ const tokenRef = 'GITHUB_TOKEN';
 const pushRepo = 'git://github.com:user/repo';
 const host = 'github.com';
 const git = { changelog: null };
+const requestErrorOptions = { request: { url: '', headers: {} }, response: { headers: {} } };
 
 test.serial('should validate token', async t => {
   const tokenRef = 'MY_GITHUB_TOKEN';
@@ -34,7 +35,6 @@ test.serial('should validate token', async t => {
 });
 
 test('should release and upload assets', async t => {
-  const asset = 'file1';
   const options = {
     git,
     github: {
@@ -43,7 +43,7 @@ test('should release and upload assets', async t => {
       release: true,
       releaseName: 'Release ${tagName}',
       releaseNotes: 'echo Custom notes',
-      assets: `test/resources/${asset}`
+      assets: 'test/resources/file-v${version}.txt'
     }
   };
   const github = factory(GitHub, { options });
@@ -53,7 +53,7 @@ test('should release and upload assets', async t => {
   interceptAuthentication();
   interceptCollaborator();
   interceptCreate({ body: { tag_name: '2.0.2', name: 'Release 2.0.2', body: 'Custom notes' } });
-  interceptAsset({ body: asset });
+  interceptAsset({ body: '*' });
 
   await runTasks(github);
 
@@ -225,7 +225,7 @@ test('should throw for unauthenticated user', async t => {
   const options = { github: { tokenRef, pushRepo, host } };
   const github = factory(GitHub, { options });
   const stub = sinon.stub(github.client.users, 'getAuthenticated');
-  stub.throws(new RequestError('Bad credentials', 401, { request: { url: '', headers: {} } }));
+  stub.throws(new RequestError('Bad credentials', 401, requestErrorOptions));
 
   await t.throwsAsync(runTasks(github), {
     message: /^Could not authenticate with GitHub using environment variable "GITHUB_TOKEN"/
@@ -240,7 +240,7 @@ test('should throw for non-collaborator', async t => {
   const options = { github: { tokenRef, pushRepo, host } };
   const github = factory(GitHub, { options });
   const stub = sinon.stub(github.client.repos, 'checkCollaborator');
-  stub.throws(new RequestError('HttpError', 401, { request: { url: '', headers: {} } }));
+  stub.throws(new RequestError('HttpError', 401, requestErrorOptions));
 
   await t.throwsAsync(runTasks(github), { message: /^User john is not a collaborator for user\/repo/ });
 
@@ -271,7 +271,7 @@ test.serial('should skip authentication and collaborator checks when running on
 test('should handle octokit client error (without retries)', async t => {
   const github = factory(GitHub, { options: { github: { tokenRef, pushRepo, host } } });
   const stub = sinon.stub(github.client.repos, 'createRelease');
-  stub.throws(new RequestError('Not found', 404, { request: { url: '', headers: {} } }));
+  stub.throws(new RequestError('Not found', 404, requestErrorOptions));
   interceptAuthentication();
   interceptCollaborator();
 
@@ -285,7 +285,7 @@ test('should handle octokit client error (with retries)', async t => {
   const options = { github: { tokenRef, pushRepo, host, retryMinTimeout: 0 } };
   const github = factory(GitHub, { options });
   const stub = sinon.stub(github.client.repos, 'createRelease');
-  stub.throws(new RequestError('Request failed', 500, { request: { url: '', headers: {} } }));
+  stub.throws(new RequestError('Request failed', 500, requestErrorOptions));
   interceptAuthentication();
   interceptCollaborator();
 
@@ -310,7 +310,7 @@ test('should not call octokit client in dry run', async t => {
   const { isReleased, releaseUrl } = github.getContext();
   t.true(isReleased);
   t.is(releaseUrl, 'https://github.com/user/repo/releases/tag/v1.0.1');
-  spy.restore();
+  spy.get.restore();
   exec.restore();
 });
 

package/test/gitlab.js

@@ -48,7 +48,6 @@ test.serial('should support CI Job token header', async t => {
 
 test.serial('should upload assets and release', async t => {
   const pushRepo = 'https://gitlab.com/user/repo';
-  const asset = 'file1';
   const options = {
     git: { pushRepo },
     gitlab: {
@@ -56,7 +55,7 @@ test.serial('should upload assets and release', async t => {
       release: true,
       releaseName: 'Release ${version}',
       releaseNotes: 'echo Custom notes',
-      assets: `test/resources/${asset}`
+      assets: 'test/resources/file-v${version}.txt'
     }
   };
   const gitlab = factory(GitLab, { options });
@@ -73,8 +72,8 @@ test.serial('should upload assets and release', async t => {
       assets: {
         links: [
           {
-            name: asset,
-            url: `${pushRepo}/uploads/7e8bec1fe27cc46a4bc6a91b9e82a07c/${asset}`
+            name: 'file-v2.0.1.txt',
+            url: `${pushRepo}/uploads/7e8bec1fe27cc46a4bc6a91b9e82a07c/file-v2.0.1.txt`
           }
         ]
       }
@@ -83,7 +82,7 @@ test.serial('should upload assets and release', async t => {
 
   await runTasks(gitlab);
 
-  t.is(gitlab.assets[0].url, `${pushRepo}/uploads/7e8bec1fe27cc46a4bc6a91b9e82a07c/${asset}`);
+  t.is(gitlab.assets[0].url, `${pushRepo}/uploads/7e8bec1fe27cc46a4bc6a91b9e82a07c/file-v2.0.1.txt`);
   const { isReleased, releaseUrl } = gitlab.getContext();
   t.true(isReleased);
   t.is(releaseUrl, `${pushRepo}/-/releases`);
@@ -192,7 +191,7 @@ test('should not make requests in dry run', async t => {
   t.is(gitlab.log.exec.args[2][0], 'gitlab releases#createRelease "R" (1.0.1)');
   t.true(isReleased);
   t.is(releaseUrl, `${pushRepo}/-/releases`);
-  spy.restore();
+  spy.get.restore();
 });
 
 test('should skip checks', async t => {

package/test/resources/file-v2.0.1.txt

@@ -0,0 +1 @@
+*

package/test/resources/file-v2.0.2.txt

@@ -0,0 +1 @@
+*

package/CHANGELOG.md

@@ -1,102 +0,0 @@
-# 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). See [deprecated.json](./config/deprecated.json) for the changes, mainly:
-
-- 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)