release-it 15.0.0-esm.3 → 15.0.0-esm.4

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)
+- [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/github/GitHub.js

@@ -38,7 +38,7 @@ class GitHub extends Release {
   async init() {
     await super.init();
 
-    const { skipChecks, tokenRef, web, update } = this.options;
+    const { skipChecks, tokenRef, web, update, assets } = this.options;
 
     if (!this.token || web) {
       if (!web) {
@@ -49,6 +49,10 @@ class GitHub extends Release {
       return;
     }
 
+    if (web && assets) {
+      this.log.warn('Assets are not included in web-based releases.');
+    }
+
     if (!skipChecks) {
       // If we're running on GitHub Actions, we can skip the authentication and
       // collaborator checks. Ref: https://bit.ly/2vsyRzu
@@ -188,12 +192,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 ? '' : releaseNotes || '';
 
     return Object.assign(options, {
       owner,
@@ -202,7 +206,8 @@ class GitHub extends Release {
       name,
       body,
       draft,
-      prerelease: isPreRelease || preRelease
+      prerelease: isPreRelease || preRelease,
+      generate_release_notes: autoGenerate
     });
   }
 

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "15.0.0-esm.3",
+  "version": "15.0.0-esm.4",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -83,7 +83,7 @@
     "os-name": "5.0.1",
     "parse-json": "5.2.0",
     "semver": "7.3.5",
-    "shelljs": "0.8.4",
+    "shelljs": "0.8.5",
     "update-notifier": "5.1.0",
     "url-join": "4.0.1",
     "uuid": "8.3.2",
@@ -94,17 +94,17 @@
     "@octokit/request-error": "2.1.0",
     "ava": "3.15.0",
     "codecov": "3.8.3",
-    "eslint": "8.3.0",
+    "eslint": "8.7.0",
     "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-ava": "13.1.0",
-    "eslint-plugin-import": "2.25.3",
+    "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.2",
     "mock-stdio": "1.0.3",
-    "nock": "13.2.1",
+    "nock": "13.2.2",
     "nyc": "15.1.0",
-    "prettier": "2.5.0",
+    "prettier": "2.5.1",
     "sinon": "12.0.1",
     "strip-ansi": "7.0.1"
   },

package/test/github.js

@@ -15,7 +15,7 @@ import {
 const tokenRef = 'GITHUB_TOKEN';
 const pushRepo = 'git://github.com:user/repo';
 const host = 'github.com';
-const git = { changelog: null };
+const git = { changelog: '' };
 const requestErrorOptions = { request: { url: '', headers: {} }, response: { headers: {} } };
 
 test.serial('should check token and perform checks', async t => {
@@ -91,7 +91,36 @@ test('should create a pre-release and draft release notes', async t => {
 
   interceptAuthentication();
   interceptCollaborator();
-  interceptCreate({ body: { tag_name: '2.0.2', name: 'Release 2.0.2', body: null, prerelease: true, draft: true } });
+  interceptCreate({ body: { tag_name: '2.0.2', name: 'Release 2.0.2', body: '', prerelease: true, draft: 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 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);
 
@@ -220,7 +249,7 @@ test('should release to alternative host and proxy', async t => {
 test('should release to git.pushRepo', async t => {
   const remote = { api: 'https://my-custom-host.org/api/v3', host: 'my-custom-host.org' };
   interceptCreate(Object.assign({ body: { tag_name: '1.0.1' } }, remote));
-  const options = { git: { pushRepo: 'upstream', changelog: null }, github: { tokenRef, skipChecks: true } };
+  const options = { git: { pushRepo: 'upstream', changelog: '' }, github: { tokenRef, skipChecks: true } };
   const github = factory(GitHub, { options });
   const exec = sinon.stub(github.shell, 'exec').callThrough();
   exec.withArgs('git log --pretty=format:"* %s (%h)" ${from}...${to}').resolves('');
@@ -371,6 +400,7 @@ test('should generate GitHub web release url', async t => {
 
 test('should generate GitHub web release url for enterprise host', async t => {
   const options = {
+    git,
     github: {
       pushRepo: 'git://my-custom-host.org:user/repo',
       release: true,

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 = '', body = '', 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,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 = '', 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/util/index.js

@@ -30,23 +30,14 @@ export let 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 @@ export let runTasks = async plugin => {
 
   const name = (await plugin.getName()) || '__test__';
   const latestVersion = (await plugin.getLatestVersion()) || '1.0.0';
-  const changelog = (await plugin.getChangelog()) || null;
-  const increment = getIncrement(plugin, { latestVersion });
+  const changelog = (await plugin.getChangelog(latestVersion)) || 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');