release-it 14.12.0 → 14.12.4

package/README.md

@@ -19,7 +19,6 @@ system, and hooks to execute any command you need to test, build, and/or publish
 
 [![Action Status](https://github.com/release-it/release-it/workflows/Cross-OS%20Tests/badge.svg)](https://github.com/release-it/release-it/actions)
 [![npm version](https://badge.fury.io/js/release-it.svg)](https://www.npmjs.com/package/release-it)
-[![codecov](https://codecov.io/gh/release-it/release-it/branch/master/graph/badge.svg)](https://codecov.io/gh/release-it/release-it)
 
 ## Links
 

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/lib/tasks.js

@@ -7,7 +7,6 @@ const Prompt = require('./prompt');
 const Spinner = require('./spinner');
 const Metrics = require('./metrics');
 const { reduceUntil, parseVersion } = require('./util');
-const handleDeprecated = require('./deprecated');
 
 const runTasks = async (opts, di) => {
   let container = {};
@@ -27,7 +26,7 @@ const runTasks = async (opts, di) => {
 
     const { log, metrics, shell, spinner } = container;
 
-    const options = handleDeprecated(config.getContext(), log);
+    const options = config.getContext();
 
     metrics.trackEvent('start', options);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "14.12.0",
+  "version": "14.12.4",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -46,8 +46,6 @@
     "lint": "eslint lib test",
     "format": "prettier --write \"{lib,test}/**/*.js\"",
     "test": "ava",
-    "coverage": "nyc --reporter=lcov --reporter=html --config=config/.codecov.yml npm test",
-    "codecov": "nyc --reporter=json --config=config/.codecov.yml npm test && codecov -f coverage/coverage-final.json",
     "readme": "markdown-toc README.md -i --maxdepth=2 --bullets=-",
     "release": "./bin/release-it.js"
   },
@@ -63,7 +61,6 @@
     "chalk": "4.1.2",
     "cosmiconfig": "7.0.1",
     "debug": "4.3.3",
-    "deprecated-obj": "2.0.0",
     "execa": "5.1.1",
     "form-data": "4.0.0",
     "git-url-parse": "11.6.0",
@@ -80,7 +77,7 @@
     "os-name": "4.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",
@@ -90,8 +87,7 @@
   "devDependencies": {
     "@octokit/request-error": "2.1.0",
     "ava": "3.15.0",
-    "codecov": "3.8.3",
-    "eslint": "8.6.0",
+    "eslint": "8.7.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-ava": "13.2.0",
     "eslint-plugin-import": "2.25.4",
@@ -99,8 +95,8 @@
     "markdown-toc": "1.2.0",
     "mock-fs": "5.1.2",
     "mock-stdio": "1.0.3",
-    "nock": "13.2.1",
-    "nyc": "15.1.0",
+    "nock": "13.2.2",
+    "node-fetch": "2.6.7",
     "prettier": "2.5.1",
     "proxyquire": "2.1.3",
     "sinon": "12.0.1",

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');
@@ -359,6 +359,7 @@ test('should skip checks', async t => {
 
 test('should generate GitHub web release url', async t => {
   const options = {
+    git,
     github: {
       pushRepo,
       release: true,
@@ -384,6 +385,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 @@
 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,

package/test/util/index.js

@@ -47,7 +47,7 @@ module.exports.runTasks = async plugin => {
 
   const name = (await plugin.getName()) || '__test__';
   const latestVersion = (await plugin.getLatestVersion()) || '1.0.0';
-  const changelog = (await plugin.getChangelog()) || null;
+  const changelog = (await plugin.getChangelog(latestVersion)) || null;
   const increment = getIncrement(plugin);
 
   plugin.config.setContext({ name, latestVersion, latestTag: latestVersion, changelog });

package/config/.codecov.yml

@@ -1,5 +0,0 @@
-coverage:
-  parsers:
-    javascript:
-      enable_partials: yes
-comment: false

package/config/deprecated.json

@@ -1 +0,0 @@
-{}

package/lib/deprecated.js

@@ -1,20 +0,0 @@
-const Deprecated = require('deprecated-obj');
-const deprecated = require('../config/deprecated.json');
-const Log = require('./log');
-
-module.exports = (config, log = new Log()) => {
-  const deprecations = new Deprecated(deprecated, config);
-  const compliant = deprecations.getCompliant();
-  const violations = deprecations.getViolations();
-  if (Object.keys(violations).length > 0) {
-    log.warn(`Deprecated configuration options found. Please migrate before the next major release.`);
-  }
-  for (const d in violations) {
-    log.warn(
-      `The "${d}" option is deprecated. ${
-        violations[d] ? (/^[A-Z]/.test(violations[d]) ? violations[d] : `Please use "${violations[d]}" instead.`) : ''
-      }`
-    );
-  }
-  return compliant;
-};

package/test/deprecated.js

@@ -1,11 +0,0 @@
-const test = require('ava');
-const sinon = require('sinon');
-const deprecated = require('../lib/deprecated');
-const Log = require('../lib/log');
-
-test('should show deprecation warnings and return compliant object', t => {
-  const log = sinon.createStubInstance(Log);
-  const config = deprecated({ keep: 1 }, log);
-  t.is(log.warn.callCount, 0);
-  t.deepEqual(config, { keep: 1 });
-});