release-it 14.12.1 → 14.12.2

package/lib/plugin/github/GitHub.js

@@ -37,7 +37,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) {
@@ -48,6 +48,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
@@ -192,7 +196,7 @@ class GitHub extends Release {
     const { version, releaseNotes } = this.getContext();
     const { isPreRelease } = parseVersion(version);
     const name = format(releaseName, this.config.getContext());
-    const body = autoGenerate ? null : releaseNotes;
+    const body = autoGenerate ? '' : releaseNotes || '';
 
     return Object.assign(options, {
       owner,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "14.12.1",
+  "version": "14.12.2",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",

package/test/github.js

@@ -15,7 +15,7 @@ const {
 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 => {
@@ -89,7 +89,7 @@ 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);
 
@@ -244,7 +244,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 describe --tags --match=* --abbrev=0').resolves('1.0.0');

package/test/stub/github.js

@@ -1,16 +1,19 @@
 const nock = require('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,14 +37,15 @@ 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, generate_release_notes = false }
-} = {}) =>
+  body: { tag_name, name = '', body = '', prerelease = false, draft = false, generate_release_notes = false }
+} = {}) => {
   nock(api)
     .post(`/repos/${owner}/${project}/releases`, {
       tag_name,
@@ -66,14 +70,15 @@ const interceptCreate = ({
       };
       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, generate_release_notes = 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, generate_release_notes })
     .reply(200, {
@@ -87,6 +92,7 @@ const interceptUpdate = ({
       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',
@@ -95,7 +101,7 @@ const interceptAsset = ({
   project = 'repo',
   tagName,
   body = {}
-} = {}) =>
+} = {}) => {
   nock(`https://uploads.${host}`)
     .post(`/repos/${owner}/${project}/releases/1/assets`, body)
     .query(true)
@@ -112,6 +118,7 @@ const interceptAsset = ({
         browser_download_url: `https://${host}/${owner}/${project}/releases/download/${tagName}/${name}`
       };
     });
+};
 
 module.exports = {
   interceptAuthentication,