release-it 14.11.6 → 14.12.0

package/README.md

@@ -321,17 +321,18 @@ While mostly used as a CLI tool, release-it can be used as a dependency to integ
 - [blockchain/blockchain-wallet-v4-frontend](https://github.com/blockchain/blockchain-wallet-v4-frontend)
 - [callstack/linaria](https://github.com/callstack/linaria)
 - [ember-cli/ember-cli](https://github.com/ember-cli/ember-cli)
-  [react-native-paper](https://github.com/callstack/react-native-paper)
+- [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)
 - [mozilla/readability](https://github.com/mozilla/readability)
-- [satya164/react-native-tab-view](https://github.com/satya164/react-native-tab-view)
+- [redis/node-redis](https://github.com/redis/node-redis)
 - [shipshapecode/shepherd](https://github.com/shipshapecode/shepherd)
 - [swagger-api/swagger-ui](https://github.com/swagger-api/swagger-ui) +
   [swagger-editor](https://github.com/swagger-api/swagger-editor)
 - [StevenBlack/hosts](https://github.com/StevenBlack/hosts)
-- [tabler](https://github.com/tabler/tabler) + [tabler-icons](https://github.com/tabler/tabler-icons)
-- [youzan/vant](https://github.com/youzan/vant/search?q=release-it)
+- [tabler/tabler](https://github.com/tabler/tabler) + [tabler-icons](https://github.com/tabler/tabler-icons)
+- [youzan/vant](https://github.com/youzan/vant)
 - [Repositories that depend on release-it](https://github.com/release-it/release-it/network/dependents)
 - GitHub search for [filename:.release-it.json](https://github.com/search?q=filename%3A.release-it.json)
 

package/config/release-it.json

@@ -33,6 +33,7 @@
     "release": false,
     "releaseName": "Release ${version}",
     "releaseNotes": null,
+    "autoGenerate": false,
     "preRelease": false,
     "draft": false,
     "tokenRef": "GITHUB_TOKEN",

package/lib/plugin/GitBase.js

@@ -99,7 +99,7 @@ class GitBase extends Plugin {
     const sha = await this.exec(`git rev-list ${latestTag || '--skip=1'} --tags --max-count=1`, {
       options
     });
-    return this.exec(`git describe --tags --abbrev=0 ${sha}^`, { options }).catch(() => null);
+    return this.exec(`git describe --tags --abbrev=0 "${sha}^"`, { options }).catch(() => null);
   }
 }
 

package/lib/plugin/github/GitHub.js

@@ -22,7 +22,7 @@ const parseErrormsg = err => {
   let msg = err;
   if (err instanceof Error) {
     const { status, message } = err;
-    const { headers } = err.response;
+    const headers = err.response ? err.response.headers : {};
     msg = `${_.get(headers, 'status', status)} (${message})`;
   }
   return msg;
@@ -187,12 +187,12 @@ class GitHub extends Release {
 
   getOctokitReleaseOptions(options = {}) {
     const { owner, project: repo } = this.getContext('repo');
-    const { releaseName, draft = false, preRelease = false } = this.options;
+    const { releaseName, draft = false, preRelease = false, autoGenerate = false } = this.options;
     const { tagName } = this.config.getContext();
     const { version, releaseNotes } = this.getContext();
     const { isPreRelease } = parseVersion(version);
     const name = format(releaseName, this.config.getContext());
-    const body = releaseNotes;
+    const body = autoGenerate ? null : releaseNotes;
 
     return Object.assign(options, {
       owner,
@@ -201,7 +201,8 @@ class GitHub extends Release {
       name,
       body,
       draft,
-      prerelease: isPreRelease || preRelease
+      prerelease: isPreRelease || preRelease,
+      generate_release_notes: autoGenerate
     });
   }
 
@@ -295,8 +296,11 @@ class GitHub extends Release {
   }
 
   generateWebUrl() {
+    const host = this.options.host || this.getContext('repo.host');
+    const isGitHub = host === 'github.com';
+
     const options = this.getOctokitReleaseOptions();
-    return newGithubReleaseUrl({
+    const url = newGithubReleaseUrl({
       user: options.owner,
       repo: options.repo,
       tag: options.tag_name,
@@ -304,6 +308,7 @@ class GitHub extends Release {
       title: options.name,
       body: options.body
     });
+    return isGitHub ? url : url.replace('github.com', host);
   }
 
   async createWebRelease() {

package/lib/plugin/version/Version.js

@@ -106,7 +106,11 @@ class Version extends Plugin {
     }
 
     if (this.config.isCI && !increment) {
-      return semver.inc(latestVersion, 'patch');
+      if (isPreRelease) {
+        return semver.inc(latestVersion, 'prepatch', preReleaseId);
+      } else {
+        return semver.inc(latestVersion, 'patch');
+      }
     }
 
     const normalizedType = RELEASE_TYPES.includes(increment) && isPreRelease ? `pre${increment}` : increment;

package/lib/tasks.js

@@ -77,24 +77,26 @@ const runTasks = async (opts, di) => {
       version = latestVersion;
     }
 
-    if (config.isReleaseVersion) {
-      log.log(version);
-      process.exit(0);
-    }
-
     config.setContext({ name, latestVersion, version, changelog });
 
     const action = config.isIncrement ? 'release' : 'update';
     const suffix = version && config.isIncrement ? `${latestVersion}...${version}` : `currently at ${latestVersion}`;
 
-    log.obtrusive(`🚀 Let's ${action} ${name} (${suffix})`);
+    if (!config.isReleaseVersion) {
+      log.obtrusive(`🚀 Let's ${action} ${name} (${suffix})`);
 
-    log.preview({ title: 'changelog', text: changelog });
+      log.preview({ title: 'changelog', text: changelog });
+    }
 
     if (config.isIncrement) {
       version = version || (await reduceUntil(plugins, plugin => plugin.getIncrementedVersion(incrementBase)));
     }
 
+    if (config.isReleaseVersion) {
+      console.log(version);
+      process.exit(0);
+    }
+
     config.setContext(parseVersion(version));
 
     if (config.isPromptOnlyVersion) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "14.11.6",
+  "version": "14.12.0",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -58,22 +58,22 @@
   "license": "MIT",
   "dependencies": {
     "@iarna/toml": "2.2.5",
-    "@octokit/rest": "18.10.0",
+    "@octokit/rest": "18.12.0",
     "async-retry": "1.3.3",
     "chalk": "4.1.2",
     "cosmiconfig": "7.0.1",
-    "debug": "4.3.2",
+    "debug": "4.3.3",
     "deprecated-obj": "2.0.0",
     "execa": "5.1.1",
     "form-data": "4.0.0",
     "git-url-parse": "11.6.0",
     "globby": "11.0.4",
-    "got": "11.8.2",
+    "got": "11.8.3",
     "import-cwd": "3.0.0",
-    "inquirer": "8.1.5",
-    "is-ci": "3.0.0",
+    "inquirer": "8.2.0",
+    "is-ci": "3.0.1",
     "lodash": "4.17.21",
-    "mime-types": "2.1.32",
+    "mime-types": "2.1.34",
     "new-github-release-url": "1.0.0",
     "open": "7.4.2",
     "ora": "5.4.1",
@@ -91,19 +91,19 @@
     "@octokit/request-error": "2.1.0",
     "ava": "3.15.0",
     "codecov": "3.8.3",
-    "eslint": "7.32.0",
+    "eslint": "8.6.0",
     "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-ava": "12.0.0",
-    "eslint-plugin-import": "2.24.2",
-    "eslint-plugin-prettier": "3.4.0",
+    "eslint-plugin-ava": "13.2.0",
+    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-prettier": "4.0.0",
     "markdown-toc": "1.2.0",
-    "mock-fs": "5.1.0",
+    "mock-fs": "5.1.2",
     "mock-stdio": "1.0.3",
-    "nock": "13.1.3",
+    "nock": "13.2.1",
     "nyc": "15.1.0",
-    "prettier": "2.4.1",
+    "prettier": "2.5.1",
     "proxyquire": "2.1.3",
-    "sinon": "11.1.2",
+    "sinon": "12.0.1",
     "strip-ansi": "6.0.0"
   },
   "engines": {

package/test/github.js

@@ -99,6 +99,35 @@ test('should create a pre-release and draft release notes', async t => {
   exec.restore();
 });
 
+test('should create auto generated release notes', async t => {
+  const options = {
+    git,
+    github: {
+      pushRepo,
+      tokenRef,
+      release: true,
+      releaseName: 'Release ${tagName}',
+      autoGenerate: true
+    }
+  };
+  const github = factory(GitHub, { options });
+  const exec = sinon.stub(github.shell, 'exec').callThrough();
+  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', draft: false, prerelease: false, generate_release_notes: true }
+  });
+
+  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();
+});
+
 test('should update release and upload assets', async t => {
   const asset = 'file1';
   const options = {
@@ -117,8 +146,8 @@ test('should update release and upload assets', async t => {
   const github = factory(GitHub, { options });
   const exec = sinon.stub(github.shell, 'exec').callThrough();
   exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1');
-  exec.withArgs('git rev-list 2.0.1 --tags --max-count=1').resolves('71f1812');
-  exec.withArgs('git describe --tags --match=* --abbrev=0 71f1812').resolves('2.0.1');
+  exec.withArgs('git rev-list 2.0.1 --tags --max-count=1').resolves('a123456');
+  exec.withArgs('git describe --tags --abbrev=0 "a123456^"').resolves('2.0.1');
 
   interceptAuthentication();
   interceptCollaborator();
@@ -150,8 +179,8 @@ test('should create new release for unreleased tag', async t => {
   const github = factory(GitHub, { options });
   const exec = sinon.stub(github.shell, 'exec').callThrough();
   exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1');
-  exec.withArgs('git rev-list 2.0.1 --tags --max-count=1').resolves('71f1812');
-  exec.withArgs('git describe --tags --match=* --abbrev=0 71f1812').resolves('2.0.1');
+  exec.withArgs('git rev-list 2.0.1 --tags --max-count=1').resolves('b123456');
+  exec.withArgs('git describe --tags --abbrev=0 "b123456^"').resolves('2.0.1');
 
   interceptAuthentication();
   interceptCollaborator();
@@ -330,7 +359,6 @@ test('should skip checks', async t => {
 
 test('should generate GitHub web release url', async t => {
   const options = {
-    git,
     github: {
       pushRepo,
       release: true,
@@ -353,3 +381,29 @@ test('should generate GitHub web release url', async t => {
   );
   exec.restore();
 });
+
+test('should generate GitHub web release url for enterprise host', async t => {
+  const options = {
+    github: {
+      pushRepo: 'git://my-custom-host.org:user/repo',
+      release: true,
+      web: true,
+      host: 'my-custom-host.org',
+      releaseName: 'The Launch',
+      releaseNotes: 'echo It happened'
+    }
+  };
+  const github = factory(GitHub, { options });
+  const exec = sinon.stub(github.shell, 'exec').callThrough();
+  exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1');
+
+  await runTasks(github);
+
+  const { isReleased, releaseUrl } = github.getContext();
+  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'
+  );
+  exec.restore();
+});

package/test/stub/github.js

@@ -40,10 +40,17 @@ const interceptCreate = ({
   host = '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)
-    .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,6 +60,7 @@ 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}`
       };
@@ -64,10 +72,10 @@ const interceptUpdate = ({
   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,6 +83,7 @@ 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}`
     });

package/test/tasks.js

@@ -397,6 +397,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();
+});
+
 {
   class MyPlugin extends Plugin {}
   const statics = { isEnabled: () => true, disablePlugin: () => null };

package/test/util/index.js

@@ -30,23 +30,14 @@ module.exports.factory = (Definition, { namespace, options = {}, container = {}
   });
 };
 
-const getIncrement = (plugin, { latestVersion }) => {
-  return (
-    plugin.getIncrement({
-      latestVersion,
-      increment: plugin.options.increment,
-      isPreRelease: false,
-      preReleaseId: null
-    }) ||
-    plugin.getContext('increment') ||
-    plugin.config.getContext('increment')
-  );
-};
+const getIncrement = plugin =>
+  plugin.getIncrement(plugin.options) || plugin.getContext('increment') || plugin.config.getContext('increment');
 
-const getVersion = async (plugin, { latestVersion, increment }) => {
+const getVersion = async (plugin, options) => {
+  const { latestVersion, increment } = options;
   return (
-    (await plugin.getIncrementedVersionCI({ latestVersion, increment })) ||
-    (await plugin.getIncrementedVersion({ latestVersion, increment })) ||
+    (await plugin.getIncrementedVersionCI(options)) ||
+    (await plugin.getIncrementedVersion(options)) ||
     (increment !== false ? semver.inc(latestVersion, increment || 'patch') : latestVersion)
   );
 };
@@ -56,12 +47,15 @@ module.exports.runTasks = async plugin => {
 
   const name = (await plugin.getName()) || '__test__';
   const latestVersion = (await plugin.getLatestVersion()) || '1.0.0';
-  const changelog = (await plugin.getChangelog(latestVersion)) || null;
-  const increment = getIncrement(plugin, { latestVersion });
+  const changelog = (await plugin.getChangelog()) || null;
+  const increment = getIncrement(plugin);
 
   plugin.config.setContext({ name, latestVersion, latestTag: latestVersion, changelog });
 
-  const version = await getVersion(plugin, { latestVersion, increment });
+  const { preRelease } = plugin.config.options;
+  const isPreRelease = Boolean(preRelease);
+  const preReleaseId = typeof preRelease === 'string' ? preRelease : null;
+  const version = await getVersion(plugin, { latestVersion, increment, isPreRelease, preReleaseId });
 
   plugin.config.setContext(parseVersion(version));
 

package/test/version.js

@@ -148,17 +148,22 @@ test('should run tasks without errors', async t => {
   await runTasks(v);
 
   t.is(getIncrement.callCount, 1);
-  t.deepEqual(getIncrement.firstCall.args[0], {
+  t.deepEqual(getIncrement.firstCall.args[0], { increment: 'minor' });
+  t.is(getIncrementedVersionCI.callCount, 1);
+  t.deepEqual(getIncrementedVersionCI.firstCall.args[0], {
     latestVersion: '1.0.0',
     increment: 'minor',
     isPreRelease: false,
     preReleaseId: null
   });
-  t.is(getIncrementedVersionCI.callCount, 1);
-  t.deepEqual(getIncrementedVersionCI.firstCall.args[0], { latestVersion: '1.0.0', increment: 'minor' });
   t.is(await incrementVersion.firstCall.returnValue, '1.1.0');
   t.is(incrementVersion.callCount, 1);
-  t.deepEqual(incrementVersion.firstCall.args[0], { latestVersion: '1.0.0', increment: 'minor' });
+  t.deepEqual(incrementVersion.firstCall.args[0], {
+    latestVersion: '1.0.0',
+    increment: 'minor',
+    isPreRelease: false,
+    preReleaseId: null
+  });
   t.is(incrementVersion.firstCall.returnValue, '1.1.0');
   const { latestVersion, version, isPreRelease, preReleaseId } = v.config.getContext();
   t.is(latestVersion, '1.0.0');