release-it 15.5.0 → 15.6.0

package/config/release-it.json

@@ -11,6 +11,7 @@
     "commitMessage": "Release ${version}",
     "commitArgs": [],
     "tag": true,
+    "tagExclude": null,
     "tagName": null,
     "tagMatch": null,
     "tagAnnotation": "Release ${version}",

package/lib/plugin/GitBase.js

@@ -93,7 +93,8 @@ class GitBase extends Plugin {
   getLatestTagName() {
     const context = Object.assign({}, this.config.getContext(), { version: '*' });
     const match = format(this.options.tagMatch || this.options.tagName || '${version}', context);
-    return this.exec(`git describe --tags --match=${match} --abbrev=0`, { options }).then(
+    const exclude = this.options.tagExclude ? ` --exclude=${format(this.options.tagExclude, context)}` : '';
+    return this.exec(`git describe --tags --match=${match} --abbrev=0${exclude}`, { options }).then(
       stdout => stdout || null,
       () => null
     );

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', 'tagMatch', 'pushRepo', 'changelog']);
+    const gitOptions = _.pick(git, ['tagExclude', 'tagName', 'tagMatch', 'pushRepo', 'changelog']);
     return _.defaults(baseOptions, gitOptions);
   }
 

package/lib/plugin/Plugin.js

@@ -65,7 +65,8 @@ class Plugin {
   step(options) {
     const context = Object.assign({}, this.config.getContext(), { [this.namespace]: this.getContext() });
     const opts = Object.assign({}, options, { context });
-    return this.config.isCI ? this.spinner.show(opts) : this.showPrompt(opts);
+    const isException = this.config.isPromptOnlyVersion && ['incrementList', 'publish', 'otp'].includes(opts.prompt);
+    return this.config.isCI && !isException ? this.spinner.show(opts) : this.showPrompt(opts);
   }
 }
 

package/lib/plugin/gitlab/GitLab.js

@@ -2,7 +2,7 @@ import fs from 'node:fs';
 import path from 'node:path';
 import got from 'got';
 import { globby } from 'globby';
-import FormData from 'form-data';
+import { FormData, fileFromSync } from 'node-fetch';
 import allSettled from 'promise.allsettled';
 import _ from 'lodash';
 import Release from '../GitRelease.js';
@@ -232,7 +232,7 @@ class GitLab extends Release {
     const endpoint = `projects/${id}/uploads`;
 
     const body = new FormData();
-    body.append('file', fs.createReadStream(filePath));
+    body.set('file', fileFromSync(filePath));
     const options = { body };
 
     try {

package/lib/plugin/npm/npm.js

@@ -92,7 +92,8 @@ class npm extends Plugin {
   release() {
     if (this.options.publish === false) return false;
     const publish = () => this.publish({ otpCallback });
-    const otpCallback = this.config.isCI ? null : task => this.step({ prompt: 'otp', task });
+    const otpCallback =
+      this.config.isCI && !this.config.isPromptOnlyVersion ? null : task => this.step({ prompt: 'otp', task });
     return this.step({ task: publish, label: 'npm publish', prompt: 'publish' });
   }
 
@@ -131,34 +132,43 @@ class npm extends Plugin {
     );
   }
 
-  isCollaborator() {
+  async isCollaborator() {
     const registry = this.getRegistry();
     const registryArg = registry ? ` --registry ${registry}` : '';
     const name = this.getName();
     const { username } = this.getContext();
     if (username === undefined) return true;
     if (username === null) return false;
-    return this.exec(`npm access ls-collaborators ${name}${registryArg}`, { options }).then(
-      output => {
-        try {
-          const collaborators = JSON.parse(output);
-          const permissions = collaborators[username];
-          return permissions && permissions.includes('write');
-        } catch (err) {
-          this.debug(err);
-          return false;
-        }
-      },
-      err => {
+
+    try {
+      let npmVersion = await this.exec('npm --version', { options });
+
+      let accessCommand;
+      if (semver.gt(npmVersion, '9.0.0')) {
+        accessCommand = 'npm access list collaborators --json';
+      } else {
+        accessCommand = 'npm access ls-collaborators';
+      }
+
+      const output = await this.exec(`${accessCommand} ${name}${registryArg}`, { options });
+
+      try {
+        const collaborators = JSON.parse(output);
+        const permissions = collaborators[username];
+        return permissions && permissions.includes('write');
+      } catch (err) {
         this.debug(err);
-        if (/code E400/.test(err)) {
-          this.log.warn('Ignoring response from unsupported `npm access` command.');
-        } else {
-          this.log.warn(`Unable to verify if user ${username} is a collaborator for ${name}.`);
-        }
-        return true;
+        return false;
       }
-    );
+    } catch (err) {
+      this.debug(err);
+      if (/code E400/.test(err)) {
+        this.log.warn('Ignoring response from unsupported `npm access` command.');
+      } else {
+        this.log.warn(`Unable to verify if user ${username} is a collaborator for ${name}.`);
+      }
+      return true;
+    }
   }
 
   async getLatestRegistryVersion() {

package/lib/util.js

@@ -20,8 +20,6 @@ const getSystemInfo = () => {
   };
 };
 
-const clean = args => args.filter(arg => arg != null);
-
 const format = (template = '', context = {}) => {
   try {
     return _.template(template)(context);
@@ -95,7 +93,6 @@ const e = (message, docs) => new Error(docs ? `${message}${EOL}Documentation: ${
 
 export {
   getSystemInfo,
-  clean,
   format,
   truncateLines,
   rejectAfter,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "15.5.0",
+  "version": "15.6.0",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -60,27 +60,26 @@
   "license": "MIT",
   "dependencies": {
     "@iarna/toml": "2.2.5",
-    "@octokit/rest": "19.0.4",
+    "@octokit/rest": "19.0.5",
     "async-retry": "1.3.3",
-    "chalk": "5.0.1",
-    "cosmiconfig": "7.0.1",
+    "chalk": "5.1.2",
+    "cosmiconfig": "8.0.0",
     "execa": "6.1.0",
-    "form-data": "4.0.0",
     "git-url-parse": "13.1.0",
     "globby": "13.1.2",
-    "got": "12.5.1",
-    "inquirer": "9.1.2",
+    "got": "12.5.3",
+    "inquirer": "9.1.4",
     "is-ci": "3.0.1",
     "lodash": "4.17.21",
     "mime-types": "2.1.35",
     "new-github-release-url": "2.0.0",
-    "node-fetch": "3.2.10",
+    "node-fetch": "3.3.0",
     "open": "8.4.0",
     "ora": "6.1.2",
     "os-name": "5.0.1",
-    "promise.allsettled": "1.0.5",
+    "promise.allsettled": "1.0.6",
     "proxy-agent": "5.0.0",
-    "semver": "7.3.7",
+    "semver": "7.3.8",
     "shelljs": "0.8.5",
     "update-notifier": "6.0.2",
     "url-join": "5.0.0",
@@ -88,19 +87,19 @@
     "yargs-parser": "21.1.1"
   },
   "devDependencies": {
-    "@octokit/request-error": "3.0.1",
-    "ava": "4.3.3",
-    "eslint": "8.24.0",
+    "@octokit/request-error": "3.0.2",
+    "ava": "5.1.0",
+    "eslint": "8.28.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-plugin-ava": "13.2.0",
     "eslint-plugin-import": "2.26.0",
     "eslint-plugin-prettier": "4.2.1",
-    "mock-fs": "5.1.4",
+    "mock-fs": "5.2.0",
     "mock-stdio": "1.0.3",
     "nock": "13.2.9",
     "nyc": "15.1.0",
-    "prettier": "2.7.1",
-    "sinon": "14.0.1",
+    "prettier": "2.8.0",
+    "sinon": "15.0.0",
     "strip-ansi": "7.0.1"
   },
   "engines": {

package/test/git.init.js

@@ -167,6 +167,23 @@ test.serial('should get the latest tag based on tagMatch', async t => {
   t.is(gitClient.config.getContext('latestTag'), '21.04.3');
 });
 
+test.serial('should get the latest tag based on tagExclude', async t => {
+  const shell = factory(Shell);
+  const gitClient = factory(Git, {
+    options: { git: { tagExclude: '*[-]*' } },
+    container: { shell }
+  });
+  sh.exec('git tag 1.0.0');
+  sh.exec('git commit --allow-empty -m "commit 1"');
+  sh.exec('git tag 1.0.1-rc.0');
+  sh.exec('git tag 1.0.1');
+  sh.exec('git commit --allow-empty -m "commit 2"');
+  sh.exec('git tag 1.1.0-rc.0');
+  sh.exec('git push --tags');
+  await gitClient.init();
+  t.is(gitClient.config.getContext('latestTag'), '1.0.1');
+});
+
 test.serial('should generate correct changelog', async t => {
   const gitClient = factory(Git, { options: { git } });
   sh.exec('git tag 1.0.0');

package/test/npm.js

@@ -182,10 +182,21 @@ test('should throw if user is not authenticated', async t => {
   exec.restore();
 });
 
-test('should throw if user is not a collaborator', async t => {
+test('should throw if user is not a collaborator (v9)', async t => {
   const npmClient = factory(npm);
   const exec = sinon.stub(npmClient.shell, 'exec').resolves();
   exec.withArgs('npm whoami').resolves('ada');
+  exec.withArgs('npm --version').resolves('9.2.0');
+  exec.withArgs('npm access list collaborators --json release-it').resolves(JSON.stringify({ john: ['write'] }));
+  await t.throwsAsync(runTasks(npmClient), { message: /^User ada is not a collaborator for release-it/ });
+  exec.restore();
+});
+
+test('should throw if user is not a collaborator (v8)', async t => {
+  const npmClient = factory(npm);
+  const exec = sinon.stub(npmClient.shell, 'exec').resolves();
+  exec.withArgs('npm whoami').resolves('ada');
+  exec.withArgs('npm --version').resolves('8.2.0');
   exec.withArgs('npm access ls-collaborators release-it').resolves(JSON.stringify({ john: ['write'] }));
   await t.throwsAsync(runTasks(npmClient), { message: /^User ada is not a collaborator for release-it/ });
   exec.restore();
@@ -307,7 +318,7 @@ test('should publish to a different/scoped registry', async t => {
     'npm ping --registry https://gitlab.com/api/v4/projects/my-scope%2Fmy-pkg/packages/npm/',
     'npm whoami --registry https://gitlab.com/api/v4/projects/my-scope%2Fmy-pkg/packages/npm/',
     'npm show @my-scope/my-pkg@latest version --registry https://gitlab.com/api/v4/projects/my-scope%2Fmy-pkg/packages/npm/',
-    'npm access ls-collaborators @my-scope/my-pkg --registry https://gitlab.com/api/v4/projects/my-scope%2Fmy-pkg/packages/npm/',
+    'npm --version',
     'npm version 1.0.1 --no-git-tag-version',
     'npm publish . --tag latest'
   ]);
@@ -341,7 +352,7 @@ test('should not publish when `npm version` fails', async t => {
     'npm ping',
     'npm whoami',
     'npm show @my-scope/my-pkg@latest version',
-    'npm access ls-collaborators @my-scope/my-pkg',
+    'npm --version',
     'npm version 1.0.1 --no-git-tag-version'
   ]);
 

package/test/tasks.js

@@ -128,7 +128,7 @@ test.serial('should use pkg.version (in sub dir) w/o tagging repo', async t => {
   const { stdout } = sh.exec('git describe --tags --match=* --abbrev=0');
   t.is(stdout.trim(), '1.0.0');
   const npmArgs = getArgs(exec.args, 'npm');
-  t.is(npmArgs[4], 'npm version 1.3.0 --no-git-tag-version');
+  t.is(npmArgs[5], 'npm version 1.3.0 --no-git-tag-version');
   exec.restore();
 });
 
@@ -174,6 +174,7 @@ test.serial('should release all the things (basic)', async t => {
     'npm ping',
     'npm whoami',
     `npm show ${pkgName}@latest version`,
+    'npm --version',
     `npm access ls-collaborators ${pkgName}`,
     'npm version 1.0.1 --no-git-tag-version',
     'npm publish . --tag latest'
@@ -307,6 +308,7 @@ test.serial('should release all the things (pre-release, github, gitlab)', async
     'npm ping',
     'npm whoami',
     `npm show ${pkgName}@latest version`,
+    'npm --version',
     `npm access ls-collaborators ${pkgName}`,
     'npm version 1.1.0-alpha.0 --no-git-tag-version',
     'npm publish . --tag alpha'
@@ -346,6 +348,7 @@ test.serial('should publish pre-release without pre-id with different npm.tag',
     'npm ping',
     'npm whoami',
     `npm show ${pkgName}@latest version`,
+    'npm --version',
     `npm access ls-collaborators ${pkgName}`,
     'npm version 2.0.0-0 --no-git-tag-version',
     'npm publish . --tag next'
@@ -393,7 +396,7 @@ test.serial('should initially publish non-private scoped npm package privately',
   await runTasks({}, container);
 
   const npmArgs = getArgs(container.shell.exec.args, 'npm');
-  t.is(npmArgs[5], 'npm publish . --tag latest');
+  t.is(npmArgs[6], 'npm publish . --tag latest');
   exec.restore();
 });