release-it 15.0.0-esm.2 → 15.0.0-esm.5

package/test/gitlab.js

@@ -6,9 +6,9 @@ import { factory, runTasks } from './util/index.js';
 import {
   interceptUser,
   interceptCollaborator,
-  interceptCollaboratorFallback,
   interceptPublish,
-  interceptAsset
+  interceptAsset,
+  interceptMilestones
 } from './stub/gitlab.js';
 
 const tokenHeader = 'Private-Token';
@@ -55,7 +55,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 +64,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 +97,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 +110,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);
@@ -162,19 +219,6 @@ test.serial('should throw for insufficient access level', async t => {
   await t.throwsAsync(runTasks(gitlab), { message: /^User john is not a collaborator for john\/repo/ });
 });
 
-test.serial('should fallback for gitlab < v12.4', async t => {
-  const host = 'https://gitlab.com';
-  const pushRepo = `${host}/user/repo`;
-  const options = { gitlab: { tokenRef, pushRepo, host } };
-  const gitlab = factory(GitLab, { options });
-  const scope = nock(host);
-  scope.get(`/api/v4/projects/user%2Frepo/members/all/1`).reply(404);
-  interceptUser();
-  interceptCollaboratorFallback();
-
-  await t.notThrowsAsync(gitlab.init());
-});
-
 test('should not make requests in dry run', async t => {
   const [host, owner, repo] = ['https://gitlab.example.org', 'user', 'repo'];
   const pushRepo = `${host}/${owner}/${repo}`;
@@ -195,7 +239,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/log.js

@@ -1,4 +1,4 @@
-import { EOL } from 'os';
+import { EOL } from 'node:os';
 import test from 'ava';
 import mockStdIo from 'mock-stdio';
 import stripAnsi from 'strip-ansi';

package/test/npm.js

@@ -1,4 +1,4 @@
-import path from 'path';
+import path from 'node:path';
 import test from 'ava';
 import sinon from 'sinon';
 import mock from 'mock-fs';
@@ -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 => {
@@ -347,3 +347,12 @@ test('should not publish when `npm version` fails', async t => {
 
   exec.restore();
 });
+
+test('should add allow-same-version argument', async t => {
+  const options = { npm: { skipChecks: true, allowSameVersion: true } };
+  const npmClient = factory(npm, { options });
+  const exec = sinon.stub(npmClient.shell, 'exec').resolves();
+  await runTasks(npmClient);
+  const version = exec.args.filter(arg => arg[0].startsWith('npm version'));
+  t.regex(version[0][0], / --allow-same-version/);
+});

package/test/plugins.js

@@ -1,3 +1,4 @@
+import { join } from 'node:path';
 import test from 'ava';
 import sh from 'shelljs';
 import sinon from 'sinon';
@@ -12,16 +13,13 @@ import ContextPlugin from './stub/plugin-context.js';
 import { mkTmpDir } from './util/helpers.js';
 import ShellStub from './stub/shell.js';
 
-const rootDir = new URL('..', import.meta.url);
-
 const noop = Promise.resolve();
 
 const sandbox = sinon.createSandbox();
 
 const testConfig = {
   ci: true,
-  config: false,
-  'disable-metrics': true
+  config: false
 };
 
 const log = sandbox.createStubInstance(Log);
@@ -39,6 +37,11 @@ const getContainer = options => {
   };
 };
 
+test.serial.before(t => {
+  t.timeout(60 * 1000);
+  sh.exec('npm link');
+});
+
 test.serial.beforeEach(t => {
   const dir = mkTmpDir();
   sh.pushd('-q', dir);
@@ -50,23 +53,28 @@ test.serial.afterEach(() => {
 });
 
 test.serial('should instantiate plugins and execute all release-cycle methods', async t => {
-  sh.ShellString(JSON.stringify({ name: 'project', version: '1.0.0', type: 'module' })).toEnd('package.json');
-  sh.exec(`npm install ${rootDir}`);
+  const { dir } = t.context;
 
   const pluginDir = mkTmpDir();
   sh.pushd('-q', pluginDir);
-  sh.ShellString(JSON.stringify({ name: 'my-plugin', version: '1.0.0', type: 'module' })).toEnd('package.json');
-  sh.exec(`npm install ${rootDir}`);
+  sh.ShellString(JSON.stringify({ name: 'my-plugin', version: '1.0.0', type: 'module' })).toEnd(
+    join(pluginDir, 'package.json')
+  );
+  sh.exec(`npm link release-it`);
   const content = "import { Plugin } from 'release-it'; " + MyPlugin.toString() + '; export default MyPlugin;';
-  sh.ShellString(content).toEnd('index.js');
-  sh.popd();
+  sh.ShellString(content).toEnd(join(pluginDir, 'index.js'));
 
+  sh.pushd('-q', dir);
   sh.mkdir('-p', 'my/plugin');
   sh.pushd('-q', 'my/plugin');
-  sh.ShellString(content).toEnd('index.js');
-  sh.popd();
+  sh.ShellString(content).toEnd(join(dir, 'my', 'plugin', 'index.js'));
 
+  sh.pushd('-q', dir);
+  sh.ShellString(JSON.stringify({ name: 'project', version: '1.0.0', type: 'module' })).toEnd(
+    join(dir, 'package.json')
+  );
   sh.exec(`npm install ${pluginDir}`);
+  sh.exec(`npm link release-it`);
 
   const config = {
     plugins: {
@@ -114,14 +122,16 @@ test.serial('should instantiate plugins and execute all release-cycle methods',
 });
 
 test.serial('should disable core plugins', async t => {
-  sh.ShellString(JSON.stringify({ name: 'project', version: '1.0.0' })).toEnd('package.json');
-  sh.exec(`npm install release-it@^14`);
-  const content = "const { Plugin } = require('release-it'); module.exports = " + ReplacePlugin.toString();
-  sh.ShellString(content).toEnd('replace-plugin.js');
+  const { dir } = t.context;
+  sh.ShellString(JSON.stringify({ name: 'project', version: '1.0.0' })).toEnd(join(dir, 'package.json'));
+  const content =
+    "import { Plugin } from 'release-it'; " + ReplacePlugin.toString() + '; export default ReplacePlugin;';
+  sh.ShellString(content).toEnd(join(dir, 'replace-plugin.mjs'));
+  sh.exec(`npm link release-it`);
 
   const config = {
     plugins: {
-      './replace-plugin.js': {}
+      './replace-plugin.mjs': {}
     }
   };
   const container = getContainer(config);
@@ -131,18 +141,20 @@ test.serial('should disable core plugins', async t => {
   t.deepEqual(result, {
     changelog: undefined,
     name: undefined,
-    latestVersion: undefined,
+    latestVersion: '0.0.0',
     version: undefined
   });
 });
 
 test.serial('should expose context to execute commands', async t => {
-  sh.ShellString(JSON.stringify({ name: 'pkg-name', version: '1.0.0', type: 'module' })).toEnd('package.json');
-  sh.exec(`npm install ${rootDir}`);
-
+  const { dir } = t.context;
+  sh.ShellString(JSON.stringify({ name: 'pkg-name', version: '1.0.0', type: 'module' })).toEnd(
+    join(dir, 'package.json')
+  );
   const content =
     "import { Plugin } from 'release-it'; " + ContextPlugin.toString() + '; export default ContextPlugin;';
-  sh.ShellString(content).toEnd('context-plugin.js');
+  sh.ShellString(content).toEnd(join(dir, 'context-plugin.js'));
+  sh.exec(`npm link release-it`);
 
   const repo = parseGitUrl('https://github.com/user/pkg');
 

package/test/spinner.js

@@ -4,16 +4,13 @@ import Spinner from '../lib/spinner.js';
 import Config from '../lib/config.js';
 
 test.beforeEach(t => {
-  t.context.ora = {
-    promise: sinon.spy()
-  };
+  t.context.ora = sinon.spy();
 });
 
 const getConfig = options => {
   const testConfig = {
     ci: false,
-    config: false,
-    'disable-metrics': true
+    config: false
   };
   return new Config(Object.assign({}, testConfig, options));
 };
@@ -24,7 +21,7 @@ test('should not show spinner and not execute task if disabled', async t => {
   const spinner = new Spinner({ container: { ora } });
   await spinner.show({ enabled: false, task });
   t.is(task.callCount, 0);
-  t.is(ora.promise.callCount, 0);
+  t.is(ora.callCount, 0);
 });
 
 test('should show spinner and run task by default', async t => {
@@ -35,9 +32,9 @@ test('should show spinner and run task by default', async t => {
   const spinner = new Spinner({ container: { ora, config } });
   await spinner.show({ task, label });
   t.is(task.callCount, 1);
-  t.is(ora.promise.callCount, 1);
-  t.is(ora.promise.firstCall.args[0], task.firstCall.returnValue);
-  t.is(ora.promise.firstCall.args[1], label);
+  t.is(ora.callCount, 1);
+  t.is(ora.firstCall.args[0], task.firstCall.returnValue);
+  t.is(ora.firstCall.args[1], label);
 });
 
 test('should run task, but not show spinner if interactive', async t => {
@@ -47,7 +44,7 @@ test('should run task, but not show spinner if interactive', async t => {
   const spinner = new Spinner({ container: { ora, config } });
   await spinner.show({ task });
   t.is(task.callCount, 1);
-  t.is(ora.promise.callCount, 0);
+  t.is(ora.callCount, 0);
 });
 
 test('should run task and show spinner if interactive, but external', async t => {
@@ -57,5 +54,5 @@ test('should run task and show spinner if interactive, but external', async t =>
   const spinner = new Spinner({ container: { ora, config } });
   await spinner.show({ task, external: true });
   t.is(task.callCount, 1);
-  t.is(ora.promise.callCount, 1);
+  t.is(ora.callCount, 1);
 });

package/test/stub/config/default/.release-it.json

@@ -0,0 +1,5 @@
+{
+  "github": {
+    "release": true
+  }
+}

package/test/stub/config/invalid-config-rc

@@ -0,0 +1 @@
+foo=bar

package/test/stub/config/invalid-config-txt

@@ -0,0 +1,2 @@
+foo
+bar\baz

package/test/stub/config/merge/.release-it.json

@@ -0,0 +1,5 @@
+{
+  "github": {
+    "release": true
+  }
+}

package/test/stub/config/merge/package.json

@@ -0,0 +1,7 @@
+{
+  "release-it": {
+    "git": {
+      "push": false
+    }
+  }
+}

package/test/stub/config/toml/.release-it.toml

@@ -0,0 +1,2 @@
+[foo]
+bar=1

package/test/stub/config/yaml/.release-it.yaml

@@ -0,0 +1,2 @@
+foo:
+  bar: 1

package/test/stub/config/yml/.release-it.yml

@@ -0,0 +1,2 @@
+foo:
+  bar: 1

package/test/stub/github.js

@@ -1,16 +1,19 @@
 import nock from 'nock';
 
-const interceptAuthentication = ({ api = 'https://api.github.com', username = 'john' } = {}) =>
+const interceptAuthentication = ({ api = 'https://api.github.com', username = 'john' } = {}) => {
   nock(api).get('/user').reply(200, {
     login: username
   });
+};
 
 const interceptCollaborator = ({
   api = 'https://api.github.com',
   owner = 'user',
   project = 'repo',
   username = 'john'
-} = {}) => nock(api).get(`/repos/${owner}/${project}/collaborators/${username}`).reply(204);
+} = {}) => {
+  nock(api).get(`/repos/${owner}/${project}/collaborators/${username}`).reply(204);
+};
 
 const interceptListReleases = ({
   host = 'github.com',
@@ -18,7 +21,7 @@ const interceptListReleases = ({
   owner = 'user',
   project = 'repo',
   tag_name
-} = {}) =>
+} = {}) => {
   nock(api)
     .get(`/repos/${owner}/${project}/releases?per_page=1&page=1`)
     .reply(200, [
@@ -34,16 +37,24 @@ const interceptListReleases = ({
         prerelease: false
       }
     ]);
+};
 
 const interceptCreate = ({
   api = 'https://api.github.com',
   host = 'github.com',
   owner = 'user',
   project = 'repo',
-  body: { tag_name, name = '', body = null, prerelease = false, draft = false }
-} = {}) =>
+  body: { tag_name, name = '', generate_release_notes = false, body = null, prerelease = false, draft = false }
+} = {}) => {
   nock(api)
-    .post(`/repos/${owner}/${project}/releases`, { tag_name, name, body, prerelease, draft })
+    .post(`/repos/${owner}/${project}/releases`, {
+      tag_name,
+      name,
+      body,
+      prerelease,
+      draft,
+      generate_release_notes
+    })
     .reply(() => {
       const id = 1;
       const responseBody = {
@@ -53,21 +64,23 @@ const interceptCreate = ({
         body,
         prerelease,
         draft,
+        generate_release_notes,
         upload_url: `https://uploads.${host}/repos/${owner}/${project}/releases/${id}/assets{?name,label}`,
         html_url: `https://${host}/${owner}/${project}/releases/tag/${tag_name}`
       };
       return [200, responseBody, { location: `${api}/repos/${owner}/${project}/releases/${id}` }];
     });
+};
 
 const interceptUpdate = ({
   host = 'github.com',
   api = 'https://api.github.com',
   owner = 'user',
   project = 'repo',
-  body: { tag_name, name = '', body = null, prerelease = false, draft = false }
-} = {}) =>
+  body: { tag_name, name = '', body = null, prerelease = false, draft = false, generate_release_notes = false }
+} = {}) => {
   nock(api)
-    .patch(`/repos/${owner}/${project}/releases/1`, { tag_name, name, body, draft, prerelease })
+    .patch(`/repos/${owner}/${project}/releases/1`, { tag_name, name, body, draft, prerelease, generate_release_notes })
     .reply(200, {
       id: 1,
       tag_name,
@@ -75,9 +88,11 @@ const interceptUpdate = ({
       body,
       prerelease,
       draft,
+      generate_release_notes,
       upload_url: `https://uploads.${host}/repos/${owner}/${project}/releases/1/assets{?name,label}`,
       html_url: `https://${host}/${owner}/${project}/releases/tag/${tag_name}`
     });
+};
 
 const interceptAsset = ({
   api = 'https://api.github.com',
@@ -86,7 +101,7 @@ const interceptAsset = ({
   project = 'repo',
   tagName,
   body = {}
-} = {}) =>
+} = {}) => {
   nock(`https://uploads.${host}`)
     .post(`/repos/${owner}/${project}/releases/1/assets`, body)
     .query(true)
@@ -103,6 +118,7 @@ const interceptAsset = ({
         browser_download_url: `https://${host}/${owner}/${project}/releases/download/${tagName}/${name}`
       };
     });
+};
 
 export {
   interceptAuthentication,

package/test/stub/gitlab.js

@@ -11,16 +11,24 @@ export let interceptCollaborator = (
     .get(`/api/v4/projects/${group ? `${group}%2F` : ''}${owner}%2F${project}/members/all/${userId}`)
     .reply(200, { id: userId, username: owner, access_level: 30 });
 
-export let interceptCollaboratorFallback = (
-  { host = 'https://gitlab.com', owner = 'user', project = 'repo', group, userId = 1 } = {},
+export let interceptPublish = ({ host = 'https://gitlab.com', owner = 'user', project = 'repo', body } = {}, options) =>
+  nock(host, options).post(`/api/v4/projects/${owner}%2F${project}/releases`, body).reply(200, {});
+
+export let interceptMilestones = (
+  { host = 'https://gitlab.com', owner = 'user', project = 'repo', query = {}, milestones = [] } = {},
   options
 ) =>
   nock(host, options)
-    .get(`/api/v4/projects/${group ? `${group}%2F` : ''}${owner}%2F${project}/members/${userId}`)
-    .reply(200, { id: userId, username: owner, access_level: 30 });
-
-export let interceptPublish = ({ host = 'https://gitlab.com', owner = 'user', project = 'repo', body } = {}, options) =>
-  nock(host, options).post(`/api/v4/projects/${owner}%2F${project}/releases`, body).reply(200, {});
+    .get(`/api/v4/projects/${owner}%2F${project}/milestones`)
+    .query(
+      Object.assign(
+        {
+          include_parent_milestones: true
+        },
+        query
+      )
+    )
+    .reply(200, JSON.stringify(milestones));
 
 export let interceptAsset = ({ host = 'https://gitlab.com', owner = 'user', project = 'repo' } = {}) =>
   nock(host)

package/test/stub/shell.js

@@ -1,7 +1,7 @@
-import _debug from 'debug';
+import util from 'node:util';
 import Shell from '../../lib/shell.js';
 
-const debug = _debug('release-it:shell-stub');
+const debug = util.debug('release-it:shell-stub');
 
 class ShellStub extends Shell {
   exec(command) {

package/test/tasks.interactive.js

@@ -1,4 +1,4 @@
-import path from 'path';
+import path from 'node:path';
 import test from 'ava';
 import sh from 'shelljs';
 import _ from 'lodash';
@@ -19,8 +19,7 @@ const sandbox = sinon.createSandbox();
 
 const testConfig = {
   ci: false,
-  config: false,
-  'disable-metrics': true
+  config: false
 };
 
 const log = sandbox.createStubInstance(Log);

package/test/tasks.js

@@ -1,4 +1,4 @@
-import path from 'path';
+import path from 'node:path';
 import test from 'ava';
 import sh from 'shelljs';
 import _ from 'lodash';
@@ -30,8 +30,7 @@ const sandbox = sinon.createSandbox();
 
 const testConfig = {
   ci: true,
-  config: false,
-  'disable-metrics': true
+  config: false
 };
 
 const log = sandbox.createStubInstance(Log);
@@ -358,7 +357,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({
@@ -397,6 +396,47 @@ test.serial('should propagate errors', async t => {
   t.is(log.error.callCount, 1);
 });
 
+test.serial('should use custom changelog command with context', async t => {
+  const { bare } = t.context;
+  const project = path.basename(bare);
+  const owner = path.basename(path.dirname(bare));
+  sh.exec('git tag v1.0.0');
+  gitAdd('line', 'file', 'More file');
+
+  interceptGitHubAuthentication();
+  interceptGitHubCollaborator({ owner, project });
+  interceptGitHubCreate({
+    owner,
+    project,
+    body: {
+      tag_name: 'v1.1.0',
+      name: 'Release 1.1.0',
+      body: 'custom-changelog-generator --from=v1.0.0 --to=v1.1.0',
+      draft: false,
+      prerelease: false
+    }
+  });
+
+  const container = getContainer({
+    increment: 'minor',
+    github: {
+      release: true,
+      releaseNotes: 'echo custom-changelog-generator --from=${latestTag} --to=${tagName}',
+      pushRepo: `https://github.com/${owner}/${project}`
+    }
+  });
+
+  const exec = sinon.spy(container.shell, 'execStringCommand');
+
+  await runTasks({}, container);
+
+  const command = exec.args.find(([command]) => command.includes('custom-changelog-generator'));
+
+  t.is(command[0], 'echo custom-changelog-generator --from=v1.0.0 --to=v1.1.0');
+
+  exec.restore();
+});
+
 {
   test.serial('should run all hooks', async t => {
     gitAdd(`{"name":"hooked","version":"1.0.0","type":"module"}`, 'package.json', 'Add package.json');

package/test/util/helpers.js

@@ -1,14 +1,14 @@
-import { promises as fs } from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
 import sh from 'shelljs';
-import tmp from 'tmp';
 
 const mkTmpDir = () => {
-  const dir = tmp.dirSync({ prefix: 'release-it-' });
-  return dir.name;
+  const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'release-it-'));
+  return dir;
 };
 
-const readFile = file => fs.readFile(path.resolve(file), 'utf8');
+const readFile = file => fs.promises.readFile(path.resolve(file), 'utf8');
 
 const gitAdd = (content, file, message) => {
   sh.ShellString(content).toEnd(file);