release-it 15.6.0 → 15.7.0

package/README.md

@@ -340,9 +340,8 @@ While mostly used as a CLI tool, release-it can be used as a dependency to integ
 
 ## Example projects using release-it
 
-- [antonmedv/fx](https://github.com/antonmedv/fx)
+- [axios/axios](https://github.com/axios/axios)
 - [blockchain/blockchain-wallet-v4-frontend](https://github.com/blockchain/blockchain-wallet-v4-frontend)
-- [callstack/linaria](https://github.com/callstack/linaria)
 - [callstack/react-native-paper](https://github.com/callstack/react-native-paper)
 - [ember-cli/ember-cli](https://github.com/ember-cli/ember-cli)
 - [js-cookie/js-cookie](https://github.com/js-cookie/js-cookie)

package/bin/release-it.js

@@ -38,5 +38,5 @@ const options = parseCliArguments([].slice.call(process.argv, 2));
 updater({ pkg: pkg }).notify();
 release(options).then(
   () => process.exit(0),
-  () => process.exit(1)
+  ({ code }) => process.exit(Number.isInteger(code) ? code : 1)
 );

package/config/release-it.json

@@ -6,6 +6,8 @@
     "requireBranch": false,
     "requireUpstream": true,
     "requireCommits": false,
+    "requireCommitsFail": true,
+    "commitsPath": "",
     "addUntrackedFiles": false,
     "commit": true,
     "commitMessage": "Release ${version}",

package/lib/plugin/git/Git.js

@@ -46,8 +46,8 @@ class Git extends GitBase {
     if (this.options.requireUpstream && !(await this.hasUpstreamBranch())) {
       throw e(`No upstream configured for current branch.${EOL}Please set an upstream branch.`, docs);
     }
-    if (this.options.requireCommits && (await this.getCommitsSinceLatestTag()) === 0) {
-      throw e(`There are no commits since the latest tag.`, docs);
+    if (this.options.requireCommits && (await this.getCommitsSinceLatestTag(this.options.commitsPath)) === 0) {
+      throw e(`There are no commits since the latest tag.`, docs, this.options.requireCommitsFail);
     }
   }
 
@@ -120,10 +120,10 @@ class Git extends GitBase {
     );
   }
 
-  async getCommitsSinceLatestTag() {
+  async getCommitsSinceLatestTag(commitsPath = '') {
     const latestTagName = await this.getLatestTagName();
     const ref = latestTagName ? `${latestTagName}..HEAD` : 'HEAD';
-    return this.exec(`git rev-list ${ref} --count`, { options }).then(Number);
+    return this.exec(`git rev-list ${ref} --count ${commitsPath}`, { options }).then(Number);
   }
 
   async getUpstreamArgs(pushRepo) {

package/lib/util.js

@@ -89,7 +89,11 @@ const parseVersion = raw => {
   };
 };
 
-const e = (message, docs) => new Error(docs ? `${message}${EOL}Documentation: ${docs}${EOL}` : message);
+const e = (message, docs, fail = true) => {
+  const error = new Error(docs ? `${message}${EOL}Documentation: ${docs}${EOL}` : message);
+  error.code = fail ? 1 : 0;
+  return error;
+};
 
 export {
   getSystemInfo,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "15.6.0",
+  "version": "15.7.0",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -60,13 +60,13 @@
   "license": "MIT",
   "dependencies": {
     "@iarna/toml": "2.2.5",
-    "@octokit/rest": "19.0.5",
+    "@octokit/rest": "19.0.7",
     "async-retry": "1.3.3",
-    "chalk": "5.1.2",
-    "cosmiconfig": "8.0.0",
-    "execa": "6.1.0",
+    "chalk": "5.2.0",
+    "cosmiconfig": "8.1.0",
+    "execa": "7.0.0",
     "git-url-parse": "13.1.0",
-    "globby": "13.1.2",
+    "globby": "13.1.3",
     "got": "12.5.3",
     "inquirer": "9.1.4",
     "is-ci": "3.0.1",
@@ -74,9 +74,9 @@
     "mime-types": "2.1.35",
     "new-github-release-url": "2.0.0",
     "node-fetch": "3.3.0",
-    "open": "8.4.0",
+    "open": "8.4.2",
     "ora": "6.1.2",
-    "os-name": "5.0.1",
+    "os-name": "5.1.0",
     "promise.allsettled": "1.0.6",
     "proxy-agent": "5.0.0",
     "semver": "7.3.8",
@@ -87,19 +87,19 @@
     "yargs-parser": "21.1.1"
   },
   "devDependencies": {
-    "@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",
+    "@octokit/request-error": "3.0.3",
+    "ava": "5.2.0",
+    "eslint": "8.35.0",
+    "eslint-config-prettier": "8.6.0",
+    "eslint-plugin-ava": "14.0.0",
+    "eslint-plugin-import": "2.27.5",
     "eslint-plugin-prettier": "4.2.1",
     "mock-fs": "5.2.0",
     "mock-stdio": "1.0.3",
-    "nock": "13.2.9",
+    "nock": "13.3.0",
     "nyc": "15.1.0",
-    "prettier": "2.8.0",
-    "sinon": "15.0.0",
+    "prettier": "2.8.4",
+    "sinon": "15.0.1",
     "strip-ansi": "7.0.1"
   },
   "engines": {

package/test/git.init.js

@@ -72,6 +72,36 @@ test.serial('should not throw if there are commits', async t => {
   await t.notThrowsAsync(gitClient.init());
 });
 
+test.serial('should fail (exit code 1) if there are no commits', async t => {
+  const options = { git: { requireCommits: true } };
+  const gitClient = factory(Git, { options });
+  sh.exec('git tag 1.0.0');
+  await t.throwsAsync(gitClient.init(), { code: 1 });
+});
+
+test.serial('should not fail (exit code 0) if there are no commits', async t => {
+  const options = { git: { requireCommits: true, requireCommitsFail: false } };
+  const gitClient = factory(Git, { options });
+  sh.exec('git tag 1.0.0');
+  await t.throwsAsync(gitClient.init(), { code: 0 });
+});
+
+test.serial('should throw if there are no commits in specified path', async t => {
+  const options = { git: { requireCommits: true, commitsPath: 'dir' } };
+  const gitClient = factory(Git, { options });
+  sh.mkdir('dir');
+  sh.exec('git tag 1.0.0');
+  await t.throwsAsync(gitClient.init(), { message: /^There are no commits since the latest tag/ });
+});
+
+test.serial('should not throw if there are commits in specified path', async t => {
+  const options = { git: { requireCommits: true, commitsPath: 'dir' } };
+  const gitClient = factory(Git, { options });
+  sh.exec('git tag 1.0.0');
+  gitAdd('line', 'dir/file', 'Add file');
+  await t.notThrowsAsync(gitClient.init());
+});
+
 test.serial('should not throw if there are no tags', async t => {
   const options = { git: { requireCommits: true } };
   const gitClient = factory(Git, { options });

package/test/npm.js

@@ -108,7 +108,7 @@ test('should add registry to commands when specified', async t => {
   const exec = sinon.stub(npmClient.shell, 'exec').resolves();
   exec.withArgs('npm whoami --registry registry.example.org').resolves('john');
   exec
-    .withArgs('npm access ls-collaborators release-it --registry registry.example.org')
+    .withArgs(/npm access (list collaborators --json|ls-collaborators) release-it --registry registry.example.org/)
     .resolves(JSON.stringify({ john: ['write'] }));
   await runTasks(npmClient);
   t.is(exec.args[0][0], 'npm ping --registry registry.example.org');
@@ -121,7 +121,9 @@ test('should not throw when executing tasks', async t => {
   const npmClient = factory(npm);
   const exec = sinon.stub(npmClient.shell, 'exec').resolves();
   exec.withArgs('npm whoami').resolves('john');
-  exec.withArgs('npm access ls-collaborators release-it').resolves(JSON.stringify({ john: ['write'] }));
+  exec
+    .withArgs(/npm access (list collaborators --json|ls-collaborators) release-it/)
+    .resolves(JSON.stringify({ john: ['write'] }));
   await t.notThrowsAsync(runTasks(npmClient));
   exec.restore();
 });
@@ -168,7 +170,9 @@ test('should not throw if npm returns 404 for unsupported ping', async t => {
   const pingError = 'npm ERR!     <title>404 - No content for path /-/ping</title>';
   exec.withArgs('npm ping').rejects(new Error(pingError));
   exec.withArgs('npm whoami').resolves('john');
-  exec.withArgs('npm access ls-collaborators release-it').resolves(JSON.stringify({ john: ['write'] }));
+  exec
+    .withArgs(/npm access (list collaborators --json|ls-collaborators) release-it/)
+    .resolves(JSON.stringify({ john: ['write'] }));
   await runTasks(npmClient);
   t.is(exec.lastCall.args[0].trim(), 'npm publish . --tag latest');
   exec.restore();
@@ -197,7 +201,9 @@ test('should throw if user is not a collaborator (v8)', async t => {
   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'] }));
+  exec
+    .withArgs(/npm access (list collaborators --json|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();
 });
@@ -207,7 +213,7 @@ test('should not throw if user is not a collaborator on a new package', async t
   const exec = sinon.stub(npmClient.shell, 'exec').resolves();
   exec.withArgs('npm whoami').resolves('ada');
   exec
-    .withArgs('npm access ls-collaborators release-it')
+    .withArgs(/npm access (list collaborators --json|ls-collaborators) release-it/)
     .rejects(
       new Error(
         'npm ERR! code E404\nnpm ERR! 404 Not Found - GET https://registry.npmjs.org/-/package/release-it/collaborators?format=cli - File not found'
@@ -268,7 +274,9 @@ test('should publish', async t => {
   const npmClient = factory(npm);
   const exec = sinon.stub(npmClient.shell, 'exec').resolves();
   exec.withArgs('npm whoami').resolves('john');
-  exec.withArgs('npm access ls-collaborators release-it').resolves(JSON.stringify({ john: ['write'] }));
+  exec
+    .withArgs(/npm access (list collaborators --json|ls-collaborators) release-it/)
+    .resolves(JSON.stringify({ john: ['write'] }));
   await runTasks(npmClient);
   t.is(exec.lastCall.args[0].trim(), 'npm publish . --tag latest');
   exec.restore();
@@ -308,7 +316,7 @@ test('should publish to a different/scoped registry', async t => {
     .resolves('john');
   exec
     .withArgs(
-      'npm access ls-collaborators @my-scope/my-pkg --registry https://gitlab.com/api/v4/projects/my-scope%2Fmy-pkg/packages/npm/'
+      /npm access (list collaborators --json|ls-collaborators) @my-scope\/my-pkg --registry https:\/\/gitlab\.com\/api\/v4\/projects\/my-scope%2Fmy-pkg\/packages\/npm\//
     )
     .resolves(JSON.stringify({ john: ['write'] }));
 
@@ -337,7 +345,9 @@ test('should not publish when `npm version` fails', async t => {
   const npmClient = factory(npm, { options });
   const exec = sinon.stub(npmClient.shell, 'exec').resolves();
   exec.withArgs('npm whoami').resolves('john');
-  exec.withArgs('npm access ls-collaborators @my-scope/my-pkg').resolves(JSON.stringify({ john: ['write'] }));
+  exec
+    .withArgs(/npm access (list collaborators --json|ls-collaborators) @my-scope\/my-pkg/)
+    .resolves(JSON.stringify({ john: ['write'] }));
   exec
     .withArgs('npm version 1.0.1 --no-git-tag-version')
     .rejects('npm ERR! Version not changed, might want --allow-same-version');

package/test/stub/github.js

@@ -30,7 +30,7 @@ const interceptListReleases = ({
         upload_url: `https://uploads.${host}/repos/${owner}/${project}/releases/1/assets{?name,label}`,
         html_url: `https://${host}/${owner}/${project}/releases/tag/${tag_name}`,
         tag_name,
-        target_commitish: 'master',
+        target_commitish: 'main',
         name: `Release ${tag_name}`,
         body: 'Description of the release',
         draft: false,

package/test/tasks.js

@@ -1,5 +1,6 @@
 import path from 'node:path';
 import test from 'ava';
+import semver from 'semver';
 import sh from 'shelljs';
 import _ from 'lodash';
 import sinon from 'sinon';
@@ -28,6 +29,8 @@ const noop = Promise.resolve();
 
 const sandbox = sinon.createSandbox();
 
+const npmMajorVersion = semver.major(process.env.npm_config_user_agent.match(/npm\/([^ ]+)/)[1]);
+
 const testConfig = {
   ci: true,
   config: false
@@ -48,6 +51,10 @@ const getContainer = options => {
   };
 };
 
+test.before(t => {
+  t.timeout(90 * 1000);
+});
+
 test.serial.beforeEach(t => {
   const bare = mkTmpDir();
   const target = mkTmpDir();
@@ -175,7 +182,7 @@ test.serial('should release all the things (basic)', async t => {
     'npm whoami',
     `npm show ${pkgName}@latest version`,
     'npm --version',
-    `npm access ls-collaborators ${pkgName}`,
+    `npm access ${npmMajorVersion >= 9 ? 'list collaborators --json' : 'ls-collaborators'} ${pkgName}`,
     'npm version 1.0.1 --no-git-tag-version',
     'npm publish . --tag latest'
   ]);
@@ -309,7 +316,7 @@ test.serial('should release all the things (pre-release, github, gitlab)', async
     'npm whoami',
     `npm show ${pkgName}@latest version`,
     'npm --version',
-    `npm access ls-collaborators ${pkgName}`,
+    `npm access ${npmMajorVersion >= 9 ? 'list collaborators --json' : 'ls-collaborators'} ${pkgName}`,
     'npm version 1.1.0-alpha.0 --no-git-tag-version',
     'npm publish . --tag alpha'
   ]);
@@ -349,7 +356,7 @@ test.serial('should publish pre-release without pre-id with different npm.tag',
     'npm whoami',
     `npm show ${pkgName}@latest version`,
     'npm --version',
-    `npm access ls-collaborators ${pkgName}`,
+    `npm access ${npmMajorVersion >= 9 ? 'list collaborators --json' : 'ls-collaborators'} ${pkgName}`,
     'npm version 2.0.0-0 --no-git-tag-version',
     'npm publish . --tag next'
   ]);

package/test/util/helpers.js

@@ -10,9 +10,14 @@ const mkTmpDir = () => {
 
 const readFile = file => fs.promises.readFile(path.resolve(file), 'utf8');
 
-const gitAdd = (content, file, message) => {
-  sh.ShellString(content).toEnd(file);
-  sh.exec(`git add ${file}`);
+const gitAdd = (content, filePath, message) => {
+  const pathSegments = filePath.split('/').filter(Boolean);
+  pathSegments.pop();
+  if (pathSegments.length) {
+    sh.mkdir('-p', pathSegments.join('/'));
+  }
+  sh.ShellString(content).toEnd(filePath);
+  sh.exec(`git add ${filePath}`);
   const { stdout } = sh.exec(`git commit -m "${message}"`);
   const match = stdout.match(/\[.+([a-z0-9]{7})\]/);
   return match ? match[1] : null;