release-it 14.12.3 → 14.13.0

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/config/release-it.json

@@ -26,6 +26,7 @@
     "tag": null,
     "otp": null,
     "ignoreVersion": false,
+    "allowSameVersion": false,
     "skipChecks": false,
     "timeout": 10
   },

package/lib/plugin/git/Git.js

@@ -1,6 +1,7 @@
 const { EOL } = require('os');
 const _ = require('lodash');
 const execa = require('execa');
+const matcher = require('wildcard-match');
 const { format, e } = require('../../util');
 const GitBase = require('../GitBase');
 const prompts = require('./prompts');
@@ -94,7 +95,7 @@ class Git extends GitBase {
   async isRequiredBranch() {
     const branch = await this.getBranchName();
     const requiredBranches = _.castArray(this.options.requireBranch);
-    return requiredBranches.includes(branch);
+    return matcher(requiredBranches)(branch);
   }
 
   async hasUpstreamBranch() {

package/lib/plugin/github/GitHub.js

@@ -193,10 +193,10 @@ class GitHub extends Release {
     const { owner, project: repo } = this.getContext('repo');
     const { releaseName, draft = false, preRelease = false, autoGenerate = false } = this.options;
     const { tagName } = this.config.getContext();
-    const { version, releaseNotes } = this.getContext();
+    const { version, releaseNotes, isUpdate } = this.getContext();
     const { isPreRelease } = parseVersion(version);
     const name = format(releaseName, this.config.getContext());
-    const body = autoGenerate ? '' : releaseNotes || '';
+    const body = autoGenerate ? (isUpdate ? null : '') : releaseNotes;
 
     return Object.assign(options, {
       owner,

package/lib/plugin/npm/npm.js

@@ -82,7 +82,8 @@ class npm extends Plugin {
 
     if (!this.config.isIncrement) return false;
 
-    const task = () => this.exec(`npm version ${version} --no-git-tag-version`);
+    const allowSameVersion = this.options.allowSameVersion ? ' --allow-same-version' : '';
+    const task = () => this.exec(`npm version ${version} --no-git-tag-version${allowSameVersion}`);
     return this.spinner.show({ task, label: 'npm version' });
   }
 

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.3",
+  "version": "14.13.0",
   "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",
@@ -84,13 +81,13 @@
     "update-notifier": "5.1.0",
     "url-join": "4.0.1",
     "uuid": "8.3.2",
+    "wildcard-match": "5.1.2",
     "yaml": "1.10.2",
     "yargs-parser": "20.2.9"
   },
   "devDependencies": {
     "@octokit/request-error": "2.1.0",
     "ava": "3.15.0",
-    "codecov": "3.8.3",
     "eslint": "8.7.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-ava": "13.2.0",
@@ -100,7 +97,7 @@
     "mock-fs": "5.1.2",
     "mock-stdio": "1.0.3",
     "nock": "13.2.2",
-    "nyc": "15.1.0",
+    "node-fetch": "2.6.7",
     "prettier": "2.5.1",
     "proxyquire": "2.1.3",
     "sinon": "12.0.1",

package/test/git.init.js

@@ -24,6 +24,19 @@ test.serial('should throw if on wrong branch', async t => {
   await t.throwsAsync(gitClient.init(), { message: /^Must be on branch dev/ });
 });
 
+test.serial('should not throw if required branch matches', async t => {
+  const options = { git: { requireBranch: 'ma?*' } };
+  const gitClient = factory(Git, { options });
+  await t.notThrowsAsync(gitClient.init());
+});
+
+test.serial('should not throw if one of required branch matches', async t => {
+  const options = { git: { requireBranch: ['release/*', 'hotfix/*'] } };
+  const gitClient = factory(Git, { options });
+  sh.exec('git checkout -b release/v1');
+  await t.notThrowsAsync(gitClient.init());
+});
+
 test.serial('should throw if there is no remote Git url', async t => {
   const gitClient = factory(Git, { options: { git } });
   sh.exec('git remote remove origin');

package/test/git.js

@@ -228,7 +228,10 @@ test.serial('should push to remote name (not "origin")', async t => {
     gitAdd('line', 'file', 'Add file');
     await gitClient.push();
     t.deepEqual(spy.lastCall.args[0], ['git', 'push', '--set-upstream', 'upstream', 'foo']);
-    t.regex(await spy.lastCall.returnValue, /Branch .?foo.? set up to track remote branch .?foo.? from .?upstream.?/);
+    t.regex(
+      await spy.lastCall.returnValue,
+      /branch .?foo.? set up to track (remote branch .?foo.? from .?upstream.?|.?upstream\/foo.?)/i
+    );
   }
   spy.restore();
 });

package/test/github.js

@@ -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: '', prerelease: true, draft: true } });
+  interceptCreate({ body: { tag_name: '2.0.2', name: 'Release 2.0.2', prerelease: true, draft: true } });
 
   await runTasks(github);
 
@@ -99,7 +99,7 @@ test('should create a pre-release and draft release notes', async t => {
   exec.restore();
 });
 
-test('should create auto generated release notes', async t => {
+test('should create auto-generated release notes', async t => {
   const options = {
     git,
     github: {
@@ -116,9 +116,7 @@ test('should create auto generated release notes', async t => {
 
   interceptAuthentication();
   interceptCollaborator();
-  interceptCreate({
-    body: { tag_name: '2.0.2', name: 'Release 2.0.2', draft: false, prerelease: false, generate_release_notes: true }
-  });
+  interceptCreate({ body: { tag_name: '2.0.2', name: 'Release 2.0.2', generate_release_notes: true, body: '' } });
 
   await runTasks(github);
 

package/test/npm.js

@@ -349,3 +349,12 @@ test('should not publish when `npm version` fails', async t => {
 
   exec.restore();
 });
+
+test('should add allow-same-version argument', async t => {
+  const options = { npm: { skipChecks: true, allowSameVersion: true } };
+  const npmClient = factory(npm, { options });
+  const exec = sinon.stub(npmClient.shell, 'exec').resolves();
+  await runTasks(npmClient);
+  const version = exec.args.filter(arg => arg[0].startsWith('npm version'));
+  t.regex(version[0][0], / --allow-same-version/);
+});

package/test/stub/github.js

@@ -44,7 +44,7 @@ const interceptCreate = ({
   host = 'github.com',
   owner = 'user',
   project = 'repo',
-  body: { tag_name, name = '', body = '', prerelease = false, draft = false, generate_release_notes = false }
+  body: { tag_name, name = '', generate_release_notes = false, body = null, prerelease = false, draft = false }
 } = {}) => {
   nock(api)
     .post(`/repos/${owner}/${project}/releases`, {
@@ -77,7 +77,7 @@ const interceptUpdate = ({
   api = 'https://api.github.com',
   owner = 'user',
   project = 'repo',
-  body: { tag_name, name = '', body = '', prerelease = false, draft = false, generate_release_notes = 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, generate_release_notes })

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 });
-});