release-it 15.1.4 → 15.4.0

package/README.md

@@ -110,6 +110,8 @@ Use `--dry-run` to show the interactivity and the commands it _would_ execute.
 
 To print the next version without releasing anything, add the `--release-version` flag.
 
+To print the changelog without releasing anything, add the `--changelog` flag.
+
 ## Configuration
 
 Out of the box, release-it has sane defaults, and [plenty of options](./config/release-it.json) to configure it. Most
@@ -275,6 +277,7 @@ latestVersion
 changelog
 name
 repo.remote, repo.protocol, repo.host, repo.owner, repo.repository, repo.project
+branchName
 ```
 
 All variables are available in all hooks. The only exception is that the additional variables listed above are not yet
@@ -297,16 +300,16 @@ Using Inquirer.js inside custom hook scripts might cause issues (since release-i
 
 Since v11, release-it can be extended in many, many ways. Here are some plugins:
 
-| Plugin                                                                                     | Description                                                                   |
-| ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------- |
-| [@release-it/bumper](https://github.com/release-it/bumper)                                 | Read & write the version from/to any file                                     |
-| [@release-it/conventional-changelog](https://github.com/release-it/conventional-changelog) | Provides recommended bump, conventional-changelog, and updates `CHANGELOG.md` |
-| [@release-it/keep-a-changelog](https://github.com/release-it/keep-a-changelog)             | Maintain CHANGELOG.md using the Keep a Changelog standards                    |
-| [@release-it-plugins/lerna-changelog](https://github.com/@release-it-plugins/lerna-changelog)| Integrates lerna-changelog into the release-it pipeline                       |
-| [@release-it-plugins/workspaces](https://github.com/@release-it-plugins/workspaces)        | Releases each of your projects configured workspaces                          |
-| [release-it-calver-plugin](https://github.com/casmith/release-it-calver-plugin)            | Enables Calendar Versioning (calver) with release-it                          |
-| [@grupoboticario/news-fragments](https://github.com/grupoboticario/news-fragments)         | An easy way to generate your changelog file                                   |
-| [@j-ulrich/release-it-regex-bumper](https://github.com/j-ulrich/release-it-regex-bumper)   | Regular expression based version read/write plugin for release-it             |
+| Plugin                                                                                       | Description                                                                   |
+| -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
+| [@release-it/bumper](https://github.com/release-it/bumper)                                   | Read & write the version from/to any file                                     |
+| [@release-it/conventional-changelog](https://github.com/release-it/conventional-changelog)   | Provides recommended bump, conventional-changelog, and updates `CHANGELOG.md` |
+| [@release-it/keep-a-changelog](https://github.com/release-it/keep-a-changelog)               | Maintain CHANGELOG.md using the Keep a Changelog standards                    |
+| [@release-it-plugins/lerna-changelog](https://github.com/release-it-plugins/lerna-changelog) | Integrates lerna-changelog into the release-it pipeline                       |
+| [@release-it-plugins/workspaces](https://github.com/release-it-plugins/workspaces)           | Releases each of your projects configured workspaces                          |
+| [release-it-calver-plugin](https://github.com/casmith/release-it-calver-plugin)              | Enables Calendar Versioning (calver) with release-it                          |
+| [@grupoboticario/news-fragments](https://github.com/grupoboticario/news-fragments)           | An easy way to generate your changelog file                                   |
+| [@j-ulrich/release-it-regex-bumper](https://github.com/j-ulrich/release-it-regex-bumper)     | Regular expression based version read/write plugin for release-it             |
 
 Internally, release-it uses its own plugin architecture (for Git, GitHub, GitLab, npm).
 

package/lib/cli.js

@@ -20,6 +20,7 @@ const helpText = `Release It! v${pkg.version}
      --only-version      Prompt only for version, no further interaction
   -v --version           Print release-it version number
      --release-version   Print version number to be released
+     --changelog         Print changelog for the version to be released
   -V --verbose           Verbose output (user hooks output)
   -VV                    Extra verbose output (also internal commands output)
 

package/lib/config.js

@@ -109,7 +109,7 @@ class Config {
   }
 
   get isCI() {
-    return Boolean(this.options.ci) || this.isReleaseVersion;
+    return Boolean(this.options.ci) || this.isReleaseVersion || this.isChangelog;
   }
 
   get isPromptOnlyVersion() {
@@ -119,6 +119,10 @@ class Config {
   get isReleaseVersion() {
     return Boolean(this.options['release-version']);
   }
+
+  get isChangelog() {
+    return Boolean(this.options['changelog']);
+  }
 }
 
 export default Config;

package/lib/index.js

@@ -78,7 +78,7 @@ const runTasks = async (opts, di) => {
     const action = config.isIncrement ? 'release' : 'update';
     const suffix = version && config.isIncrement ? `${latestVersion}...${version}` : `currently at ${latestVersion}`;
 
-    if (!config.isReleaseVersion) {
+    if (!config.isReleaseVersion && !config.isChangelog) {
       log.obtrusive(`🚀 Let's ${action} ${name} (${suffix})`);
 
       log.preview({ title: 'changelog', text: changelog });
@@ -93,6 +93,11 @@ const runTasks = async (opts, di) => {
       process.exit(0);
     }
 
+    if (config.isChangelog) {
+      console.log(changelog);
+      process.exit(0);
+    }
+
     if (version) {
       config.setContext(parseVersion(version));
 

package/lib/plugin/GitBase.js

@@ -7,14 +7,18 @@ const changelogFallback = 'git log --pretty=format:"* %s (%h)"';
 
 class GitBase extends Plugin {
   async init() {
-    this.remoteUrl = await this.getRemoteUrl();
-    await this.fetch();
-    const repo = parseGitUrl(this.remoteUrl);
-    const latestTag = await this.getLatestTagName(repo);
+    const remoteUrl = await this.getRemoteUrl();
+    await this.fetch(remoteUrl);
+
+    const branchName = await this.getBranchName();
+    const repo = parseGitUrl(remoteUrl);
+    this.setContext({ remoteUrl, branchName, repo });
+    this.config.setContext({ remoteUrl, branchName, repo });
+
+    const latestTag = await this.getLatestTagName();
     const secondLatestTag = !this.config.isIncrement ? await this.getSecondLatestTagName(latestTag) : null;
     const tagTemplate = this.options.tagName || ((latestTag || '').match(/^v/) ? 'v${version}' : '${version}');
-    this.setContext({ repo });
-    this.config.setContext({ tagTemplate, latestTag, secondLatestTag });
+    this.config.setContext({ latestTag, secondLatestTag, tagTemplate });
   }
 
   getName() {
@@ -79,15 +83,15 @@ class GitBase extends Plugin {
     return this.exec(`git config --get branch.${branch}.remote`, { options }).catch(() => null);
   }
 
-  fetch() {
+  fetch(remoteUrl) {
     return this.exec('git fetch').catch(err => {
       this.debug(err);
-      throw new Error(`Unable to fetch from ${this.remoteUrl}${EOL}${err.message}`);
+      throw new Error(`Unable to fetch from ${remoteUrl}${EOL}${err.message}`);
     });
   }
 
-  getLatestTagName(repo) {
-    const context = Object.assign({ repo }, this.getContext(), { version: '*' });
+  getLatestTagName() {
+    const context = Object.assign({}, this.config.getContext(), { version: '*' });
     const match = format(this.options.tagMatch || this.options.tagName || '${version}', context);
     return this.exec(`git describe --tags --match=${match} --abbrev=0`, { options }).then(
       stdout => stdout || null,

package/lib/plugin/factory.js

@@ -37,7 +37,15 @@ const load = async pluginName => {
       plugin = module.default;
     }
   }
-  return [path.parse(pluginName).name, plugin];
+  return [getPluginName(pluginName), plugin];
+};
+
+export const getPluginName = pluginName => {
+  if (pluginName.startsWith('.')) {
+    return path.parse(pluginName).name;
+  }
+
+  return pluginName;
 };
 
 export let getPlugins = async (config, container) => {

package/lib/plugin/git/Git.js

@@ -39,7 +39,8 @@ class Git extends GitBase {
 
     await super.init();
 
-    if (this.options.push && !this.remoteUrl) {
+    const remoteUrl = this.getContext('remoteUrl');
+    if (this.options.push && !remoteUrl) {
       throw e(`Could not get remote Git url.${EOL}Please add a remote repository.`, docs);
     }
     if (this.options.requireUpstream && !(await this.hasUpstreamBranch())) {
@@ -48,7 +49,6 @@ class Git extends GitBase {
     if (this.options.requireCommits && (await this.getCommitsSinceLatestTag()) === 0) {
       throw e(`There are no commits since the latest tag.`, docs);
     }
-    this.config.setContext({ repo: this.getContext('repo') });
   }
 
   rollback() {

package/lib/plugin/npm/npm.js

@@ -29,6 +29,7 @@ class npm extends Plugin {
   async init() {
     const { name, version: latestVersion, private: isPrivate, publishConfig } = readJSON(path.resolve(MANIFEST_PATH));
     this.setContext({ name, latestVersion, private: isPrivate, publishConfig });
+    this.config.setContext({ npm: { name } });
 
     const { publish, skipChecks } = this.options;
 

package/lib/util.js

@@ -48,10 +48,10 @@ const rejectAfter = (ms, error) =>
 
 const parseGitUrl = remoteUrl => {
   if (!remoteUrl) return { host: null, owner: null, project: null, protocol: null, remote: null, repository: null };
-  const normalizedUrl = (remoteUrl || '').replace(/\\/g, '/');
+  const normalizedUrl = (remoteUrl || '').replace(/^[A-Z]:/, '').replace(/\\/g, '/'); // Hacky workaround for file protocol in Windows
   const parsedUrl = gitUrlParse(normalizedUrl);
   const { resource: host, name: project, protocol, href: remote } = parsedUrl;
-  const owner = protocol === 'file' ? _.last(parsedUrl.owner.split('/')) : parsedUrl.owner;
+  const owner = protocol === 'file' ? _.last(parsedUrl.owner.split('/')) : parsedUrl.owner; // Fix owner for file protocol
   const repository = `${owner}/${project}`;
   return { host, owner, project, protocol, remote, repository };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "15.1.4",
+  "version": "15.4.0",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -38,6 +38,7 @@
   "type": "module",
   "exports": {
     ".": "./lib/index.js",
+    "./package.json": "./package.json",
     "./test/util/index.js": "./test/util/index.js"
   },
   "files": [
@@ -67,13 +68,13 @@
     "form-data": "4.0.0",
     "git-url-parse": "12.0.0",
     "globby": "13.1.2",
-    "got": "12.1.0",
-    "inquirer": "9.0.2",
+    "got": "12.3.1",
+    "inquirer": "9.1.0",
     "is-ci": "3.0.1",
     "lodash": "4.17.21",
     "mime-types": "2.1.35",
     "new-github-release-url": "2.0.0",
-    "node-fetch": "3.2.9",
+    "node-fetch": "3.2.10",
     "open": "8.4.0",
     "ora": "6.1.2",
     "os-name": "5.0.1",
@@ -84,17 +85,17 @@
     "update-notifier": "6.0.2",
     "url-join": "5.0.0",
     "wildcard-match": "5.1.2",
-    "yargs-parser": "21.0.1"
+    "yargs-parser": "21.1.1"
   },
   "devDependencies": {
     "@octokit/request-error": "3.0.0",
     "ava": "4.3.1",
-    "eslint": "8.20.0",
+    "eslint": "8.21.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-plugin-ava": "13.2.0",
     "eslint-plugin-import": "2.26.0",
     "eslint-plugin-prettier": "4.2.1",
-    "mock-fs": "5.1.2",
+    "mock-fs": "5.1.4",
     "mock-stdio": "1.0.3",
     "nock": "13.2.9",
     "nyc": "15.1.0",

package/test/git.js

@@ -294,8 +294,8 @@ test.serial('should roll back when cancelled', async t => {
   await gitClient.tag();
   await gitClient.rollbackOnce();
 
-  t.is(exec.args[10][0], 'git tag --delete v1.2.4');
-  t.is(exec.args[11][0], 'git reset --hard HEAD~1');
+  t.is(exec.args[11][0], 'git tag --delete v1.2.4');
+  t.is(exec.args[12][0], 'git reset --hard HEAD~1');
 });
 
 test.serial('should not touch existing history when rolling back', async t => {

package/test/github.js

@@ -357,7 +357,7 @@ test('should not call octokit client in dry run', async t => {
   await runTasks(github);
 
   t.is(spy.get.callCount, 0);
-  t.is(github.log.exec.args[0][0], 'octokit repos.createRelease "R 1.0.1" (v1.0.1)');
+  t.is(github.log.exec.args[1][0], 'octokit repos.createRelease "R 1.0.1" (v1.0.1)');
   t.is(github.log.exec.lastCall.args[0], 'octokit repos.uploadReleaseAssets');
   const { isReleased, releaseUrl } = github.getContext();
   t.true(isReleased);

package/test/gitlab.js

@@ -231,8 +231,8 @@ test('should not make requests in dry run', async t => {
 
   const { isReleased, releaseUrl } = gitlab.getContext();
   t.is(spy.get.callCount, 0);
-  t.is(gitlab.log.exec.args[1][0], 'gitlab releases#uploadAssets');
-  t.is(gitlab.log.exec.args[2][0], 'gitlab releases#createRelease "R" (1.0.1)');
+  t.is(gitlab.log.exec.args[2][0], 'gitlab releases#uploadAssets');
+  t.is(gitlab.log.exec.args[3][0], 'gitlab releases#createRelease "R" (1.0.1)');
   t.true(isReleased);
   t.is(releaseUrl, `${pushRepo}/-/releases`);
   spy.get.restore();

package/test/plugin-name.js

@@ -0,0 +1,9 @@
+import test from 'ava';
+import { getPluginName } from '../lib/plugin/factory.js';
+
+test('pluginName can return correct name for variants', t => {
+  t.is(getPluginName('plain-plugin'), 'plain-plugin');
+  t.is(getPluginName('@some/scoped-plugin'), '@some/scoped-plugin');
+  t.is(getPluginName('@some/nested/scoped-plugin'), '@some/nested/scoped-plugin');
+  t.is(getPluginName('./relative-plugin.cjs'), 'relative-plugin');
+});

package/test/plugins.js

@@ -121,6 +121,57 @@ test.serial('should instantiate plugins and execute all release-cycle methods',
   });
 });
 
+test.serial('should instantiate plugins and execute all release-cycle methods for scoped plugins', async t => {
+  const { dir } = t.context;
+
+  const pluginDir = mkTmpDir();
+  sh.pushd('-q', pluginDir);
+  sh.ShellString(JSON.stringify({ name: '@scoped/my-plugin', version: '1.0.0', type: 'module' })).toEnd(
+    join(pluginDir, 'package.json')
+  );
+  sh.exec(`npm link release-it`);
+  const content = "import { Plugin } from 'release-it'; " + MyPlugin.toString() + '; export default MyPlugin;';
+  sh.ShellString(content).toEnd(join(pluginDir, 'index.js'));
+
+  sh.pushd('-q', dir);
+  sh.ShellString(JSON.stringify({ name: 'project', version: '1.0.0', type: 'module' })).toEnd(
+    join(dir, 'package.json')
+  );
+  sh.exec(`npm install ${pluginDir}`);
+  sh.exec(`npm link release-it`);
+
+  const config = {
+    plugins: {
+      '@scoped/my-plugin': {
+        name: 'foo'
+      }
+    }
+  };
+  const container = getContainer(config);
+
+  const result = await runTasks({}, container);
+
+  t.deepEqual(container.log.info.args, [
+    ['@scoped/my-plugin:foo:init'],
+    ['@scoped/my-plugin:foo:getName'],
+    ['@scoped/my-plugin:foo:getLatestVersion'],
+    ['@scoped/my-plugin:foo:getIncrement'],
+    ['@scoped/my-plugin:foo:getIncrementedVersionCI'],
+    ['@scoped/my-plugin:foo:beforeBump'],
+    ['@scoped/my-plugin:foo:bump:1.3.0'],
+    ['@scoped/my-plugin:foo:beforeRelease'],
+    ['@scoped/my-plugin:foo:release'],
+    ['@scoped/my-plugin:foo:afterRelease']
+  ]);
+
+  t.deepEqual(result, {
+    changelog: undefined,
+    name: 'new-project-name',
+    latestVersion: '1.2.3',
+    version: '1.3.0'
+  });
+});
+
 test.serial('should disable core plugins', async t => {
   const { dir } = t.context;
   sh.ShellString(JSON.stringify({ name: 'project', version: '1.0.0' })).toEnd(join(dir, 'package.json'));

package/test/tasks.interactive.js

@@ -60,7 +60,7 @@ const getHooks = plugins => {
 };
 
 test.before(t => {
-  t.timeout(60 * 1000);
+  t.timeout(90 * 1000);
 });
 
 test.serial.beforeEach(t => {

package/test/tasks.js

@@ -186,6 +186,49 @@ test.serial('should release all the things (basic)', async t => {
   exec.restore();
 });
 
+test.serial('should release with correct tag name', async t => {
+  const { bare, target } = t.context;
+  const project = path.basename(bare);
+  const pkgName = path.basename(target);
+  const owner = path.basename(path.dirname(bare));
+  const { stdout } = sh.exec('git rev-parse --abbrev-ref HEAD');
+  const branchName = stdout.trim();
+  gitAdd(`{"name":"${pkgName}","version":"1.0.0"}`, 'package.json', 'Add package.json');
+  sh.exec(`git tag ${pkgName}-${branchName}-1.0.0`);
+  const sha = gitAdd('line', 'file', 'More file');
+
+  interceptGitHubCreate({
+    owner,
+    project,
+    body: {
+      tag_name: `${pkgName}-${branchName}-1.0.1`,
+      name: 'Release 1.0.1',
+      body: `* More file (${sha})`,
+      prerelease: false
+    }
+  });
+
+  const container = getContainer({
+    git: { tagName: '${npm.name}-${branchName}-${version}' },
+    github: { release: true, skipChecks: true, pushRepo: `https://github.com/${owner}/${project}` }
+  });
+
+  const exec = sinon.spy(container.shell, 'exec');
+
+  await runTasks({}, container);
+
+  const gitArgs = getArgs(container.shell.exec.args, 'git');
+
+  t.true(gitArgs.includes(`git tag --annotate --message Release 1.0.1 ${pkgName}-${branchName}-1.0.1`));
+  t.true(
+    log.log.secondCall.args[0].endsWith(
+      `https://github.com/${owner}/${project}/releases/tag/${pkgName}-${branchName}-1.0.1`
+    )
+  );
+
+  exec.restore();
+});
+
 test.serial('should release all the things (pre-release, github, gitlab)', async t => {
   const { bare, target } = t.context;
   const project = path.basename(bare);

package/test/util/helpers.js

@@ -19,6 +19,9 @@ const gitAdd = (content, file, message) => {
 };
 
 const getArgs = (args, prefix) =>
-  args.filter(args => typeof args[0] === 'string' && args[0].startsWith(prefix)).map(args => args[0].trim());
+  args
+    .map(args => (typeof args[0] !== 'string' ? args[0].join(' ') : args[0]))
+    .filter(cmd => cmd.startsWith(prefix))
+    .map(cmd => cmd.trim());
 
 export { mkTmpDir, readFile, gitAdd, getArgs };