release-it 14.13.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:
@@ -323,7 +331,7 @@ While mostly used as a CLI tool, release-it can be used as a dependency to integ
 - [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)
 - [redis/node-redis](https://github.com/redis/node-redis)
 - [shipshapecode/shepherd](https://github.com/shipshapecode/shepherd)

package/config/release-it.json

@@ -49,6 +49,7 @@
     "release": false,
     "releaseName": "Release ${version}",
     "releaseNotes": null,
+    "milestones": [],
     "tokenRef": "GITLAB_TOKEN",
     "tokenHeader": "Private-Token",
     "certificateAuthorityFile": null,

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');
@@ -107,6 +108,66 @@ class GitLab extends Release {
     }
   }
 
+  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
+        }
+      };
+      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() {
     const glRelease = () => this.createRelease();
     const glUploadAssets = () => this.uploadAssets();
@@ -138,6 +199,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 +223,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "14.13.0",
+  "version": "14.14.1",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -60,7 +60,7 @@
     "async-retry": "1.3.3",
     "chalk": "4.1.2",
     "cosmiconfig": "7.0.1",
-    "debug": "4.3.3",
+    "debug": "4.3.4",
     "execa": "5.1.1",
     "form-data": "4.0.0",
     "git-url-parse": "11.6.0",
@@ -70,13 +70,14 @@
     "inquirer": "8.2.0",
     "is-ci": "3.0.1",
     "lodash": "4.17.21",
-    "mime-types": "2.1.34",
+    "mime-types": "2.1.35",
     "new-github-release-url": "1.0.0",
     "open": "7.4.2",
     "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,19 +89,19 @@
   "devDependencies": {
     "@octokit/request-error": "2.1.0",
     "ava": "3.15.0",
-    "eslint": "8.7.0",
-    "eslint-config-prettier": "8.3.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.2",
+    "nock": "13.2.4",
     "node-fetch": "2.6.7",
-    "prettier": "2.5.1",
+    "prettier": "2.6.2",
     "proxyquire": "2.1.3",
-    "sinon": "12.0.1",
+    "sinon": "13.0.1",
     "strip-ansi": "6.0.0"
   },
   "engines": {

package/test/github.js

@@ -214,7 +214,7 @@ test('should release to enterprise host', async t => {
 });
 
 test('should release to alternative host and proxy', async t => {
-  const remote = { api: 'https://my-custom-host.org/api/v3', host: 'my-custom-host.org' };
+  const remote = { api: 'https://custom.example.org/api/v3', host: 'custom.example.org' };
   interceptAuthentication(remote);
   interceptCollaborator(remote);
   interceptCreate(Object.assign({ body: { tag_name: '1.0.1' } }, remote));
@@ -222,8 +222,8 @@ test('should release to alternative host and proxy', async t => {
     git,
     github: {
       tokenRef,
-      pushRepo: `git://my-custom-host.org:user/repo`,
-      host: 'my-custom-host.org',
+      pushRepo: `git://custom.example.org:user/repo`,
+      host: 'custom.example.org',
       proxy: 'http://proxy:8080'
     }
   };
@@ -235,24 +235,24 @@ test('should release to alternative host and proxy', async t => {
 
   const { isReleased, releaseUrl } = github.getContext();
   t.true(isReleased);
-  t.is(releaseUrl, `https://my-custom-host.org/user/repo/releases/tag/1.0.1`);
+  t.is(releaseUrl, `https://custom.example.org/user/repo/releases/tag/1.0.1`);
   exec.restore();
 });
 
 test('should release to git.pushRepo', async t => {
-  const remote = { api: 'https://my-custom-host.org/api/v3', host: 'my-custom-host.org' };
+  const remote = { api: 'https://custom.example.org/api/v3', host: 'custom.example.org' };
   interceptCreate(Object.assign({ body: { tag_name: '1.0.1' } }, remote));
   const options = { git: { pushRepo: 'upstream', changelog: '' }, github: { tokenRef, skipChecks: true } };
   const github = factory(GitHub, { options });
   const exec = sinon.stub(github.shell, 'exec').callThrough();
   exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('1.0.0');
-  exec.withArgs('git remote get-url upstream').resolves('https://my-custom-host.org/user/repo');
+  exec.withArgs('git remote get-url upstream').resolves('https://custom.example.org/user/repo');
 
   await runTasks(github);
 
   const { isReleased, releaseUrl } = github.getContext();
   t.true(isReleased);
-  t.is(releaseUrl, 'https://my-custom-host.org/user/repo/releases/tag/1.0.1');
+  t.is(releaseUrl, 'https://custom.example.org/user/repo/releases/tag/1.0.1');
   exec.restore();
 });
 
@@ -385,10 +385,10 @@ test('should generate GitHub web release url for enterprise host', async t => {
   const options = {
     git,
     github: {
-      pushRepo: 'git://my-custom-host.org:user/repo',
+      pushRepo: 'git://custom.example.org:user/repo',
       release: true,
       web: true,
-      host: 'my-custom-host.org',
+      host: 'custom.example.org',
       releaseName: 'The Launch',
       releaseNotes: 'echo It happened'
     }
@@ -403,7 +403,7 @@ test('should generate GitHub web release url for enterprise host', async t => {
   t.true(isReleased);
   t.is(
     releaseUrl,
-    'https://my-custom-host.org/user/repo/releases/new?tag=2.0.2&title=The+Launch&body=It+happened&prerelease=false'
+    'https://custom.example.org/user/repo/releases/new?tag=2.0.2&title=The+Launch&body=It+happened&prerelease=false'
   );
   exec.restore();
 });

package/test/gitlab.js

@@ -7,7 +7,8 @@ const {
   interceptCollaborator,
   interceptCollaboratorFallback,
   interceptPublish,
-  interceptAsset
+  interceptAsset,
+  interceptMilestones
 } = require('./stub/gitlab');
 const { factory, runTasks } = require('./util');
 
@@ -55,7 +56,8 @@ test.serial('should upload assets and release', async t => {
       release: true,
       releaseName: 'Release ${version}',
       releaseNotes: 'echo Custom notes',
-      assets: 'test/resources/file-v${version}.txt'
+      assets: 'test/resources/file-v${version}.txt',
+      milestones: ['${version}', '${latestVersion} UAT']
     }
   };
   const gitlab = factory(GitLab, { options });
@@ -63,6 +65,26 @@ test.serial('should upload assets and release', async t => {
 
   interceptUser();
   interceptCollaborator();
+  interceptMilestones({
+    query: { title: '2.0.1' },
+    milestones: [
+      {
+        id: 17,
+        iid: 3,
+        title: '2.0.1'
+      }
+    ]
+  });
+  interceptMilestones({
+    query: { title: '2.0.0 UAT' },
+    milestones: [
+      {
+        id: 42,
+        iid: 4,
+        title: '2.0.0 UAT'
+      }
+    ]
+  });
   interceptAsset();
   interceptPublish({
     body: {
@@ -76,7 +98,8 @@ test.serial('should upload assets and release', async t => {
             url: `${pushRepo}/uploads/7e8bec1fe27cc46a4bc6a91b9e82a07c/file-v2.0.1.txt`
           }
         ]
-      }
+      },
+      milestones: ['2.0.1', '2.0.0 UAT']
     }
   });
 
@@ -88,6 +111,41 @@ test.serial('should upload assets and release', async t => {
   t.is(releaseUrl, `${pushRepo}/-/releases`);
 });
 
+test.serial('should throw when release milestone is missing', async t => {
+  const pushRepo = 'https://gitlab.com/user/repo';
+  const options = {
+    git: { pushRepo },
+    gitlab: {
+      tokenRef,
+      release: true,
+      milestones: ['${version}', '${latestVersion} UAT']
+    }
+  };
+  const gitlab = factory(GitLab, { options });
+  sinon.stub(gitlab, 'getLatestVersion').resolves('2.0.0');
+
+  interceptUser();
+  interceptCollaborator();
+  interceptMilestones({
+    query: { title: '2.0.1' },
+    milestones: [
+      {
+        id: 17,
+        iid: 3,
+        title: '2.0.1'
+      }
+    ]
+  });
+  interceptMilestones({
+    query: { title: '2.0.0 UAT' },
+    milestones: []
+  });
+
+  await t.throwsAsync(runTasks(gitlab), {
+    message: /^Missing one or more milestones in GitLab. Creating a GitLab release will fail./
+  });
+});
+
 test.serial('should release to self-managed host', async t => {
   const host = 'https://gitlab.example.org';
   const scope = nock(host);
@@ -195,7 +253,14 @@ test('should not make requests in dry run', async t => {
 });
 
 test('should skip checks', async t => {
-  const options = { gitlab: { tokenRef, skipChecks: true } };
+  const options = { gitlab: { tokenRef, skipChecks: true, release: true, milestones: ['v1.0.0'] } };
   const gitlab = factory(GitLab, { options });
+  const spy = sinon.spy(gitlab, 'client', ['get']);
+
   await t.notThrowsAsync(gitlab.init());
+  await t.notThrowsAsync(gitlab.beforeRelease());
+
+  t.is(spy.get.callCount, 0);
+
+  t.is(gitlab.log.exec.args.filter(entry => /checkReleaseMilestones/.test(entry[0])).length, 0);
 });

package/test/npm.js

@@ -13,9 +13,9 @@ test('should return npm package url', t => {
 });
 
 test('should return npm package url (custom registry)', t => {
-  const options = { npm: { name: 'my-cool-package', publishConfig: { registry: 'https://my-registry.com/' } } };
+  const options = { npm: { name: 'my-cool-package', publishConfig: { registry: 'https://registry.example.org/' } } };
   const npmClient = factory(npm, { options });
-  t.is(npmClient.getPackageUrl(), 'https://my-registry.com/package/my-cool-package');
+  t.is(npmClient.getPackageUrl(), 'https://registry.example.org/package/my-cool-package');
 });
 
 test('should return default tag', async t => {

package/test/stub/gitlab.js

@@ -19,6 +19,22 @@ module.exports.interceptCollaboratorFallback = (
     .get(`/api/v4/projects/${group ? `${group}%2F` : ''}${owner}%2F${project}/members/${userId}`)
     .reply(200, { id: userId, username: owner, access_level: 30 });
 
+module.exports.interceptMilestones = (
+  { host = 'https://gitlab.com', owner = 'user', project = 'repo', query = {}, milestones = [] } = {},
+  options
+) =>
+  nock(host, options)
+    .get(`/api/v4/projects/${owner}%2F${project}/milestones`)
+    .query(
+      Object.assign(
+        {
+          include_parent_milestones: true
+        },
+        query
+      )
+    )
+    .reply(200, JSON.stringify(milestones));
+
 module.exports.interceptPublish = (
   { host = 'https://gitlab.com', owner = 'user', project = 'repo', body } = {},
   options

package/test/tasks.js

@@ -358,7 +358,7 @@ test.serial('should initially publish non-private scoped npm package privately',
 test.serial('should use pkg.publishConfig.registry', async t => {
   const { target } = t.context;
   const pkgName = path.basename(target);
-  const registry = 'https://my-registry.com';
+  const registry = 'https://my-registry.example.org';
 
   gitAdd(
     JSON.stringify({

package/test/util/index.js

@@ -47,10 +47,11 @@ module.exports.runTasks = async plugin => {
 
   const name = (await plugin.getName()) || '__test__';
   const latestVersion = (await plugin.getLatestVersion()) || '1.0.0';
+  const latestTag = plugin.config.getContext('latestTag');
   const changelog = (await plugin.getChangelog(latestVersion)) || null;
   const increment = getIncrement(plugin);
 
-  plugin.config.setContext({ name, latestVersion, latestTag: latestVersion, changelog });
+  plugin.config.setContext({ name, latestVersion, latestTag, changelog });
 
   const { preRelease } = plugin.config.options;
   const isPreRelease = Boolean(preRelease);