release-it 15.0.0-esm.3 → 15.0.0-esm.6

package/README.md

@@ -19,7 +19,6 @@ 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)
-[![codecov](https://codecov.io/gh/release-it/release-it/branch/master/graph/badge.svg)](https://codecov.io/gh/release-it/release-it)
 
 ## Links
 
@@ -256,7 +255,7 @@ will run one after another. Some example release-it configuration:
 The variables can be found in the [default configuration](./config/release-it.json). Additionally, the following
 variables are exposed:
 
-```
+```text
 version
 latestVersion
 changelog
@@ -272,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:
@@ -299,14 +306,13 @@ Deprecated. Please see [distribution repository](./docs/recipes/distribution-rep
 
 ## Metrics
 
-Use `--disable-metrics` to opt-out of sending some anonymous statistical data to Google Analytics. For details, refer to
-[lib/metrics.js](./lib/metrics.js). Please consider to not opt-out: more data means more support for future development.
+In release-it v15, anonymous metrics have been removed from the codebase and no data is sent or stored anywhere.
 
 ## Troubleshooting & debugging
 
 - 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 `NODE_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.
 
@@ -321,17 +327,18 @@ While mostly used as a CLI tool, release-it can be used as a dependency to integ
 - [blockchain/blockchain-wallet-v4-frontend](https://github.com/blockchain/blockchain-wallet-v4-frontend)
 - [callstack/linaria](https://github.com/callstack/linaria)
 - [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)
-- [mirumee/saleor](https://github.com/mirumee/saleor)
+- [saleor/saleor](https://github.com/saleor/saleor)
 - [mozilla/readability](https://github.com/mozilla/readability)
-- [satya164/react-native-tab-view](https://github.com/satya164/react-native-tab-view)
+- [redis/node-redis](https://github.com/redis/node-redis)
 - [shipshapecode/shepherd](https://github.com/shipshapecode/shepherd)
 - [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](https://github.com/tabler/tabler) + [tabler-icons](https://github.com/tabler/tabler-icons)
-- [youzan/vant](https://github.com/youzan/vant/search?q=release-it)
+- [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)
 

package/config/release-it.json

@@ -26,6 +26,7 @@
     "tag": null,
     "otp": null,
     "ignoreVersion": false,
+    "allowSameVersion": false,
     "skipChecks": false,
     "timeout": 10
   },
@@ -33,6 +34,7 @@
     "release": false,
     "releaseName": "Release ${version}",
     "releaseNotes": null,
+    "autoGenerate": false,
     "preRelease": false,
     "draft": false,
     "tokenRef": "GITHUB_TOKEN",
@@ -47,6 +49,7 @@
     "release": false,
     "releaseName": "Release ${version}",
     "releaseNotes": null,
+    "milestones": [],
     "tokenRef": "GITLAB_TOKEN",
     "tokenHeader": "Private-Token",
     "certificateAuthorityFile": null,

package/lib/config.js

@@ -1,13 +1,11 @@
+import util from 'node:util';
 import { cosmiconfigSync } from 'cosmiconfig';
-import parseJson from 'parse-json';
 import parseToml from '@iarna/toml/parse-string.js';
-import yaml from 'yaml';
 import _ from 'lodash';
 import isCI from 'is-ci';
-import _debug from 'debug';
 import { readJSON, getSystemInfo } from './util.js';
 
-const debug = _debug('release-it:config');
+const debug = util.debug('release-it:config');
 const defaultConfig = readJSON(new URL('../config/release-it.json', import.meta.url));
 
 const searchPlaces = [
@@ -21,19 +19,17 @@ const searchPlaces = [
 ];
 
 const loaders = {
-  '.json': (_, content) => parseJson(content),
-  '.toml': (_, content) => parseToml(content),
-  '.yaml': (_, content) => yaml.parse(content)
+  '.toml': (_, content) => parseToml(content)
 };
 
-const getLocalConfig = localConfigFile => {
+const getLocalConfig = ({ file, dir = process.cwd() }) => {
   let localConfig = {};
-  if (localConfigFile === false) return localConfig;
+  if (file === false) return localConfig;
   const explorer = cosmiconfigSync('release-it', {
     searchPlaces,
     loaders
   });
-  const result = localConfigFile ? explorer.load(localConfigFile) : explorer.search();
+  const result = file ? explorer.load(file) : explorer.search(dir);
   if (result && typeof result.config === 'string') {
     throw new Error(`Invalid configuration file at ${result.filepath}`);
   }
@@ -44,7 +40,7 @@ const getLocalConfig = localConfigFile => {
 class Config {
   constructor(config = {}) {
     this.constructorConfig = config;
-    this.localConfig = getLocalConfig(config.config);
+    this.localConfig = getLocalConfig({ file: config.config, dir: config.configDir });
     this.options = this.mergeOptions();
     this.options = this.expandPreReleaseShorthand(this.options);
     this.contextOptions = {};
@@ -123,10 +119,6 @@ class Config {
   get isReleaseVersion() {
     return Boolean(this.options['release-version']);
   }
-
-  get isCollectMetrics() {
-    return !this.options['disable-metrics'];
-  }
 }
 
 export default Config;

package/lib/index.js

@@ -5,9 +5,7 @@ import Config from './config.js';
 import Shell from './shell.js';
 import Prompt from './prompt.js';
 import Spinner from './spinner.js';
-import Metrics from './metrics.js';
 import { reduceUntil, parseVersion } from './util.js';
-import handleDeprecated from './deprecated.js';
 import Plugin from './plugin/Plugin.js';
 
 const runTasks = async (opts, di) => {
@@ -23,14 +21,11 @@ const runTasks = async (opts, di) => {
     container.log = container.log || new Logger({ isCI, isVerbose, verbosityLevel, isDryRun });
     container.spinner = container.spinner || new Spinner({ container, config });
     container.prompt = container.prompt || new Prompt({ container: { config } });
-    container.metrics = new Metrics({ isEnabled: config.isCollectMetrics });
     container.shell = container.shell || new Shell({ container });
 
-    const { log, metrics, shell, spinner } = container;
+    const { log, shell, spinner } = container;
 
-    const options = handleDeprecated(config.getContext(), log);
-
-    metrics.trackEvent('start', options);
+    const options = config.getContext();
 
     const { hooks } = options;
 
@@ -78,47 +73,49 @@ const runTasks = async (opts, di) => {
       version = latestVersion;
     }
 
-    if (config.isReleaseVersion) {
-      log.log(version);
-      process.exit(0);
-    }
-
     config.setContext({ name, latestVersion, version, changelog });
 
     const action = config.isIncrement ? 'release' : 'update';
     const suffix = version && config.isIncrement ? `${latestVersion}...${version}` : `currently at ${latestVersion}`;
 
-    log.obtrusive(`🚀 Let's ${action} ${name} (${suffix})`);
+    if (!config.isReleaseVersion) {
+      log.obtrusive(`🚀 Let's ${action} ${name} (${suffix})`);
 
-    log.preview({ title: 'changelog', text: changelog });
+      log.preview({ title: 'changelog', text: changelog });
+    }
 
     if (config.isIncrement) {
       version = version || (await reduceUntil(plugins, plugin => plugin.getIncrementedVersion(incrementBase)));
     }
 
-    config.setContext(parseVersion(version));
-
-    if (config.isPromptOnlyVersion) {
-      config.setCI(true);
+    if (config.isReleaseVersion) {
+      console.log(version);
+      process.exit(0);
     }
 
-    for (const hook of ['beforeBump', 'bump', 'beforeRelease']) {
-      for (const plugin of plugins) {
-        const args = hook === 'bump' ? [version] : [];
-        await runLifeCycleHook(plugin, hook, ...args);
+    if (version) {
+      config.setContext(parseVersion(version));
+
+      if (config.isPromptOnlyVersion) {
+        config.setCI(true);
       }
-    }
 
-    plugins = [...internal, ...external];
+      for (const hook of ['beforeBump', 'bump', 'beforeRelease']) {
+        for (const plugin of plugins) {
+          const args = hook === 'bump' ? [version] : [];
+          await runLifeCycleHook(plugin, hook, ...args);
+        }
+      }
 
-    for (const hook of ['release', 'afterRelease']) {
-      for (const plugin of plugins) {
-        await runLifeCycleHook(plugin, hook);
+      plugins = [...internal, ...external];
+
+      for (const hook of ['release', 'afterRelease']) {
+        for (const plugin of plugins) {
+          await runLifeCycleHook(plugin, hook);
+        }
       }
     }
 
-    await metrics.trackEvent('end');
-
     log.log(`🏁 Done (in ${Math.floor(process.uptime())}s.)`);
 
     return {
@@ -128,10 +125,7 @@ const runTasks = async (opts, di) => {
       version
     };
   } catch (err) {
-    const { log, metrics } = container;
-    if (metrics) {
-      await metrics.trackException(err);
-    }
+    const { log } = container;
     log ? log.error(err.message || err) : console.error(err); // eslint-disable-line no-console
     throw err;
   }

package/lib/log.js

@@ -1,4 +1,4 @@
-import { EOL } from 'os';
+import { EOL } from 'node:os';
 import chalk from 'chalk';
 import _ from 'lodash';
 

package/lib/plugin/GitBase.js

@@ -1,4 +1,4 @@
-import { EOL } from 'os';
+import { EOL } from 'node:os';
 import { format, parseGitUrl } from '../util.js';
 import Plugin from './Plugin.js';
 

package/lib/plugin/GitRelease.js

@@ -12,7 +12,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/Plugin.js

@@ -1,4 +1,4 @@
-import debug from 'debug';
+import { debug } from 'node:util';
 import _ from 'lodash';
 
 class Plugin {

package/lib/plugin/factory.js

@@ -1,15 +1,15 @@
-import url from 'url';
-import path from 'path';
-import { createRequire } from 'module';
+import url from 'node:url';
+import path from 'node:path';
+import util from 'node:util';
+import { createRequire } from 'node:module';
 import _ from 'lodash';
-import _debug from 'debug';
 import Version from './version/Version.js';
 import Git from './git/Git.js';
 import GitLab from './gitlab/GitLab.js';
 import GitHub from './github/GitHub.js';
 import npm from './npm/npm.js';
 
-const debug = _debug('release-it:plugins');
+const debug = util.debug('release-it:plugins');
 
 const pluginNames = ['npm', 'git', 'github', 'gitlab', 'version'];
 

package/lib/plugin/git/Git.js

@@ -1,6 +1,7 @@
-import { EOL } from 'os';
+import { EOL } from 'node:os';
 import _ from 'lodash';
 import { execa } from 'execa';
+import matcher from 'wildcard-match';
 import { format, e } from '../../util.js';
 import GitBase from '../GitBase.js';
 import prompts from './prompts.js';
@@ -94,7 +95,7 @@ class Git extends GitBase {
   async isRequiredBranch() {
     const branch = await this.getBranchName();
     const requiredBranches = _.castArray(this.options.requireBranch);
-    return requiredBranches.includes(branch);
+    return matcher(requiredBranches)(branch);
   }
 
   async hasUpstreamBranch() {

package/lib/plugin/github/GitHub.js

@@ -1,5 +1,5 @@
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
 import open from 'open';
 import { Octokit } from '@octokit/rest';
 import { globby } from 'globby';
@@ -7,6 +7,7 @@ import mime from 'mime-types';
 import _ from 'lodash';
 import retry from 'async-retry';
 import newGithubReleaseUrl from 'new-github-release-url';
+import ProxyAgent from 'proxy-agent';
 import { format, parseVersion, readJSON, e } from '../../util.js';
 import Release from '../GitRelease.js';
 import prompts from './prompts.js';
@@ -38,7 +39,7 @@ class GitHub extends Release {
   async init() {
     await super.init();
 
-    const { skipChecks, tokenRef, web, update } = this.options;
+    const { skipChecks, tokenRef, web, update, assets } = this.options;
 
     if (!this.token || web) {
       if (!web) {
@@ -49,6 +50,10 @@ class GitHub extends Release {
       return;
     }
 
+    if (web && assets) {
+      this.log.warn('Assets are not included in web-based releases.');
+    }
+
     if (!skipChecks) {
       // If we're running on GitHub Actions, we can skip the authentication and
       // collaborator checks. Ref: https://bit.ly/2vsyRzu
@@ -164,7 +169,7 @@ class GitHub extends Release {
     };
 
     if (proxy) {
-      options.proxy = proxy;
+      options.request.agent = new ProxyAgent(proxy);
     }
 
     const client = new Octokit(options);
@@ -188,12 +193,12 @@ class GitHub extends Release {
 
   getOctokitReleaseOptions(options = {}) {
     const { owner, project: repo } = this.getContext('repo');
-    const { releaseName, draft = false, preRelease = false } = this.options;
+    const { releaseName, draft = false, preRelease = false, autoGenerate = false } = this.options;
     const { tagName } = this.config.getContext();
-    const { version, releaseNotes } = this.getContext();
+    const { version, releaseNotes, isUpdate } = this.getContext();
     const { isPreRelease } = parseVersion(version);
     const name = format(releaseName, this.config.getContext());
-    const body = releaseNotes;
+    const body = autoGenerate ? (isUpdate ? null : '') : releaseNotes;
 
     return Object.assign(options, {
       owner,
@@ -202,7 +207,8 @@ class GitHub extends Release {
       name,
       body,
       draft,
-      prerelease: isPreRelease || preRelease
+      prerelease: isPreRelease || preRelease,
+      generate_release_notes: autoGenerate
     });
   }
 

package/lib/plugin/gitlab/GitLab.js

@@ -1,8 +1,9 @@
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import path from 'node:path';
 import got from 'got';
 import { globby } from 'globby';
 import FormData from 'form-data';
+import allSettled from 'promise.allsettled';
 import _ from 'lodash';
 import Release from '../GitRelease.js';
 import { format, e } from '../../util.js';
@@ -91,20 +92,68 @@ class GitLab extends Release {
       return access_level && access_level >= 30;
     } catch (err) {
       this.debug(err);
-      if (err.name === 'HTTPError' && err.response.statusCode === 404) {
-        // Using another endpoint, since "/projects/:id/members/all/:user_id" was introduced in v12.4
-        const endpoint = `projects/${id}/members/${user.id}`;
-        try {
-          const { access_level } = await this.request(endpoint, { method: 'GET' });
-          return access_level && access_level >= 30;
-        } catch (err) {
-          this.debug(err);
-          return false;
+      return false;
+    }
+  }
+
+  async beforeRelease() {
+    await super.beforeRelease();
+    await this.checkReleaseMilestones();
+  }
+
+  async checkReleaseMilestones() {
+    if (this.options.skipChecks) return;
+
+    const releaseMilestones = this.getReleaseMilestones();
+    if (releaseMilestones.length < 1) {
+      return;
+    }
+
+    this.log.exec(`gitlab releases#checkReleaseMilestones`);
+
+    const { id } = this.getContext();
+    const endpoint = `projects/${id}/milestones`;
+    const requests = releaseMilestones.map(milestone => {
+      const options = {
+        method: 'GET',
+        searchParams: {
+          title: milestone,
+          include_parent_milestones: true
         }
-      } else {
-        return false;
-      }
+      };
+      return this.request(endpoint, options).then(response => {
+        if (!Array.isArray(response)) {
+          const { baseUrl } = this.getContext();
+          throw new Error(
+            `Unexpected response from ${baseUrl}/${endpoint}. Expected an array but got: ${JSON.stringify(response)}`
+          );
+        }
+        if (response.length === 0) {
+          const error = new Error(`Milestone '${milestone}' does not exist.`);
+          this.log.warn(error.message);
+          throw error;
+        }
+        this.log.verbose(`gitlab releases#checkReleaseMilestones: milestone '${milestone}' exists`);
+      });
+    });
+    try {
+      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);
+          }
+        }
+      });
+    } catch (err) {
+      this.debug(err);
+      throw err;
     }
+    this.log.verbose('gitlab releases#checkReleaseMilestones: done');
+  }
+
+  getReleaseMilestones() {
+    const { milestones } = this.options;
+    return (milestones || []).map(milestone => format(milestone, this.config.getContext()));
   }
 
   async release() {
@@ -138,6 +187,7 @@ class GitLab extends Release {
     const name = format(releaseName, this.config.getContext());
     const description = releaseNotes || '-';
     const releaseUrl = `${origin}/${repo.repository}/-/releases`;
+    const releaseMilestones = this.getReleaseMilestones();
 
     this.log.exec(`gitlab releases#createRelease "${name}" (${tagName})`, { isDryRun });
 
@@ -161,6 +211,10 @@ class GitLab extends Release {
       };
     }
 
+    if (releaseMilestones.length) {
+      options.json.milestones = releaseMilestones;
+    }
+
     try {
       await this.request(endpoint, options);
       this.log.verbose('gitlab releases#createRelease: done');

package/lib/plugin/npm/npm.js

@@ -1,4 +1,4 @@
-import path from 'path';
+import path from 'node:path';
 import semver from 'semver';
 import urlJoin from 'url-join';
 import Plugin from '../Plugin.js';
@@ -82,7 +82,8 @@ class npm extends Plugin {
 
     if (!this.config.isIncrement) return false;
 
-    const task = () => this.exec(`npm version ${version} --no-git-tag-version`);
+    const allowSameVersion = this.options.allowSameVersion ? ' --allow-same-version' : '';
+    const task = () => this.exec(`npm version ${version} --no-git-tag-version${allowSameVersion}`);
     return this.spinner.show({ task, label: 'npm version' });
   }
 

package/lib/plugin/version/Version.js

@@ -106,7 +106,11 @@ class Version extends Plugin {
     }
 
     if (this.config.isCI && !increment) {
-      return semver.inc(latestVersion, 'patch');
+      if (isPreRelease) {
+        return semver.inc(latestVersion, 'prepatch', preReleaseId);
+      } else {
+        return semver.inc(latestVersion, 'patch');
+      }
     }
 
     const normalizedType = RELEASE_TYPES.includes(increment) && isPreRelease ? `pre${increment}` : increment;

package/lib/shell.js

@@ -1,9 +1,9 @@
+import util from 'node:util';
 import sh from 'shelljs';
 import { execa } from 'execa';
-import _debug from 'debug';
 import { format } from './util.js';
 
-const debug = _debug('release-it:shell');
+const debug = util.debug('release-it:shell');
 
 sh.config.silent = !debug.enabled;
 

package/lib/util.js

@@ -1,5 +1,5 @@
-import fs from 'fs';
-import { EOL } from 'os';
+import fs from 'node:fs';
+import { EOL } from 'node:os';
 import _ from 'lodash';
 import gitUrlParse from 'git-url-parse';
 import semver from 'semver';