release-it 15.6.1 → 15.8.0

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/plugin/github/GitHub.js

@@ -31,6 +31,12 @@ const parseErrormsg = err => {
   return msg;
 };
 
+const truncateBody = body => {
+  // https://github.com/release-it/release-it/issues/965
+  if (body && body.length >= 124000) return body.substring(0, 124000) + '...';
+  return body;
+};
+
 class GitHub extends Release {
   constructor(...args) {
     super(...args);
@@ -200,7 +206,7 @@ class GitHub extends Release {
     const { version, releaseNotes, isUpdate } = this.getContext();
     const { isPreRelease } = parseVersion(version);
     const name = format(releaseName, this.config.getContext());
-    const body = autoGenerate ? (isUpdate ? null : '') : releaseNotes;
+    const body = autoGenerate ? (isUpdate ? null : '') : truncateBody(releaseNotes);
 
     return Object.assign(options, {
       owner,

package/lib/plugin/npm/npm.js

@@ -91,6 +91,7 @@ class npm extends Plugin {
 
   release() {
     if (this.options.publish === false) return false;
+    if (this.getContext('private')) return false;
     const publish = () => this.publish({ otpCallback });
     const otpCallback =
       this.config.isCI && !this.config.isPromptOnlyVersion ? null : task => this.step({ prompt: 'otp', task });

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.1",
+  "version": "15.8.0",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -67,7 +67,7 @@
     "execa": "7.0.0",
     "git-url-parse": "13.1.0",
     "globby": "13.1.3",
-    "got": "12.5.3",
+    "got": "12.6.0",
     "inquirer": "9.1.4",
     "is-ci": "3.0.1",
     "lodash": "4.17.21",
@@ -90,7 +90,7 @@
     "@octokit/request-error": "3.0.3",
     "ava": "5.2.0",
     "eslint": "8.35.0",
-    "eslint-config-prettier": "8.6.0",
+    "eslint-config-prettier": "8.7.0",
     "eslint-plugin-ava": "14.0.0",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-prettier": "4.2.1",

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/github.js

@@ -425,3 +425,34 @@ test('should generate GitHub web release url for enterprise host', async t => {
   );
   exec.restore();
 });
+
+// eslint-disable-next-line ava/no-skip-test
+test.skip('should truncate long body', async t => {
+  const releaseNotes = 'a'.repeat(125001);
+  const body = 'a'.repeat(124000) + '...';
+  const options = {
+    git,
+    github: {
+      pushRepo,
+      tokenRef,
+      release: true,
+      releaseName: 'Release ${tagName}',
+      releaseNotes: 'echo ' + releaseNotes
+    }
+  };
+  const github = factory(GitHub, { options });
+  const exec = sinon.stub(github.shell, 'exec').callThrough();
+  exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves('');
+  exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1');
+
+  interceptAuthentication();
+  interceptCollaborator();
+  interceptCreate({ body: { tag_name: '2.0.2', name: 'Release 2.0.2', body } });
+
+  await runTasks(github);
+
+  const { isReleased, releaseUrl } = github.getContext();
+  t.true(isReleased);
+  t.is(releaseUrl, 'https://github.com/user/repo/releases/tag/2.0.2');
+  exec.restore();
+});

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

@@ -51,6 +51,10 @@ const getContainer = options => {
   };
 };
 
+test.before(t => {
+  t.timeout(90 * 1000);
+});
+
 test.serial.beforeEach(t => {
   const bare = mkTmpDir();
   const target = mkTmpDir();
@@ -380,7 +384,7 @@ test.serial('should handle private package correctly, bump lockfile', async t =>
   const npmArgs = getArgs(container.shell.exec.args, 'npm');
   t.deepEqual(npmArgs, ['npm version 1.0.1 --no-git-tag-version']);
   t.true(log.obtrusive.firstCall.args[0].endsWith(`release ${pkgName} (1.0.0...1.0.1)`));
-  t.is(log.warn.lastCall.args[0], 'Skip publish: package is private.');
+  t.is(log.warn.length, 0);
   t.regex(log.log.firstCall.args[0], /Done \(in [0-9]+s\.\)/);
 
   exec.restore();

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;