release-it 16.1.5 → 16.2.0

package/README.md

@@ -42,7 +42,7 @@ npm install -D release-it
     "release": "release-it"
   },
   "devDependencies": {
-    "release-it": "^15.10.0"
+    "release-it": "^16.1.0"
   }
 }
 ```
@@ -252,6 +252,7 @@ changelog
 name
 repo.remote, repo.protocol, repo.host, repo.owner, repo.repository, repo.project
 branchName
+releaseUrl
 ```
 
 All variables are available in all hooks. The only exception is that the additional variables listed above are not yet

package/lib/config.js

@@ -49,12 +49,23 @@ class Config {
   }
 
   expandPreReleaseShorthand(options) {
-    const { increment, preRelease, preReleaseId } = options;
+    const { increment, preRelease, preReleaseId, snapshot } = options;
+    const isPreRelease = Boolean(preRelease) || Boolean(snapshot);
+    const inc = snapshot ? 'prerelease' : increment;
+    const preId = typeof preRelease === 'string' ? preRelease : typeof snapshot === 'string' ? snapshot : preReleaseId;
     options.version = {
-      increment,
-      isPreRelease: Boolean(preRelease),
-      preReleaseId: typeof preRelease === 'string' ? preRelease : preReleaseId
+      increment: inc,
+      isPreRelease,
+      preReleaseId: preId
     };
+    if (typeof snapshot === 'string' && options.git) {
+      // Pre set and hard code some options
+      options.git.tagMatch = `0.0.0-${snapshot}.[0-9]*`;
+      options.git.getLatestTagFromAllRefs = true;
+      options.git.requireBranch = '!main';
+      options.git.requireUpstream = false;
+      options.npm.ignoreVersion = true;
+    }
     return options;
   }
 

package/lib/index.js

@@ -69,6 +69,12 @@ const runTasks = async (opts, di) => {
 
     const incrementBase = { latestVersion, increment, isPreRelease, preReleaseId };
 
+    const { snapshot } = config.options;
+    if (snapshot && !incrementBase.latestVersion.startsWith('0.0.0')) {
+      // Reading the latest version first allows to increment the final counter, fake it if it's not a snapshot:
+      incrementBase.latestVersion = `0.0.0-${snapshot}.-1`;
+    }
+
     let version;
     if (config.isIncrement) {
       incrementBase.increment = await reduceUntil(plugins, plugin => plugin.getIncrement(incrementBase));

package/lib/plugin/GitBase.js

@@ -32,6 +32,7 @@ class GitBase extends Plugin {
   }
 
   async getChangelog() {
+    const { snapshot } = this.config.getContext();
     const { latestTag, secondLatestTag } = this.config.getContext();
     const context = { latestTag, from: latestTag, to: 'HEAD' };
     const { changelog } = this.options;
@@ -42,6 +43,9 @@ class GitBase extends Plugin {
       context.to = `${latestTag}^1`;
     }
 
+    // For now, snapshots do not get a changelog, as it often goes haywire (easy to add to release manually)
+    if (snapshot) return '';
+
     if (!context.from && changelog.includes('${from}')) {
       return this.exec(changelogFallback);
     }

package/lib/plugin/git/Git.js

@@ -95,7 +95,14 @@ class Git extends GitBase {
   async isRequiredBranch() {
     const branch = await this.getBranchName();
     const requiredBranches = _.castArray(this.options.requireBranch);
-    return matcher(requiredBranches)(branch);
+    const [branches, negated] = requiredBranches.reduce(
+      ([p, n], b) => (b.startsWith('!') ? [p, [...n, b.slice(1)]] : [[...p, b], n]),
+      [[], []]
+    );
+    return (
+      (branches.length > 0 ? matcher(branches)(branch) : true) &&
+      (negated.length > 0 ? !matcher(negated)(branch) : true)
+    );
   }
 
   async hasUpstreamBranch() {

package/lib/plugin/github/GitHub.js

@@ -248,6 +248,7 @@ class GitHub extends Release {
         this.debug(response.data);
         const { html_url, upload_url, id } = response.data;
         this.setContext({ isReleased: true, releaseId: id, releaseUrl: html_url, upload_url });
+        this.config.setContext({ isReleased: true, releaseId: id, releaseUrl: html_url, upload_url });
         this.log.verbose(`octokit repos.createRelease: done (${response.headers.location})`);
         return response.data;
       } catch (err) {

package/lib/plugin/gitlab/GitLab.js

@@ -219,6 +219,7 @@ class GitLab extends Release {
       await this.request(endpoint, options);
       this.log.verbose('gitlab releases#createRelease: done');
       this.setContext({ isReleased: true, releaseUrl });
+      this.config.setContext({ isReleased: true, releaseUrl });
       return true;
     } catch (err) {
       this.debug(err);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "16.1.5",
+  "version": "16.2.0",
   "description": "Generic CLI tool to automate versioning and package publishing-related tasks.",
   "keywords": [
     "build",
@@ -65,12 +65,12 @@
     "@octokit/rest": "19.0.13",
     "async-retry": "1.3.3",
     "chalk": "5.3.0",
-    "cosmiconfig": "8.2.0",
+    "cosmiconfig": "8.3.6",
     "execa": "7.2.0",
     "git-url-parse": "13.1.0",
     "globby": "13.2.2",
     "got": "13.0.0",
-    "inquirer": "9.2.10",
+    "inquirer": "9.2.11",
     "is-ci": "3.0.1",
     "issue-parser": "6.0.0",
     "lodash": "4.17.21",
@@ -80,8 +80,8 @@
     "open": "9.1.0",
     "ora": "7.0.1",
     "os-name": "5.1.0",
-    "promise.allsettled": "1.0.6",
-    "proxy-agent": "6.3.0",
+    "promise.allsettled": "1.0.7",
+    "proxy-agent": "6.3.1",
     "semver": "7.5.4",
     "shelljs": "0.8.5",
     "update-notifier": "6.0.2",
@@ -92,17 +92,17 @@
   "devDependencies": {
     "@octokit/request-error": "3.0.3",
     "ava": "5.3.1",
-    "eslint": "8.46.0",
+    "eslint": "8.50.0",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-ava": "14.0.0",
-    "eslint-plugin-import": "2.28.0",
+    "eslint-plugin-import": "2.28.1",
     "eslint-plugin-prettier": "5.0.0",
     "fs-monkey": "1.0.4",
     "knip": "2.19.1",
-    "memfs": "4.2.1",
+    "memfs": "4.4.0",
     "mock-stdio": "1.0.3",
-    "nock": "13.3.2",
-    "prettier": "3.0.1",
+    "nock": "13.3.3",
+    "prettier": "3.0.3",
     "remark-cli": "11.0.0",
     "remark-preset-webpro": "0.0.3",
     "sinon": "15.2.0",

package/test/config.js

@@ -131,3 +131,14 @@ test('should expand pre-release shortcut (including increment and npm.tag)', t =
     preReleaseId: 'rc'
   });
 });
+
+test('should expand pre-release shortcut (snapshot)', t => {
+  const config = new Config({ snapshot: 'feat' });
+  t.deepEqual(config.options.version, {
+    increment: 'prerelease',
+    isPreRelease: true,
+    preReleaseId: 'feat'
+  });
+  t.is(config.options.git.tagMatch, '0.0.0-feat.[0-9]*');
+  t.true(config.options.git.getLatestTagFromAllRefs);
+});

package/test/git.init.js

@@ -26,6 +26,13 @@ test.serial('should throw if on wrong branch', async t => {
   await t.throwsAsync(gitClient.init(), { message: /^Must be on branch dev/ });
 });
 
+test.serial('should throw if on negated branch', async t => {
+  const options = { git: { requireBranch: '!main' } };
+  const gitClient = factory(Git, { options });
+  sh.exec('git checkout -b main');
+  await t.throwsAsync(gitClient.init(), { message: /^Must be on branch !main/ });
+});
+
 test.serial('should not throw if required branch matches', async t => {
   const options = { git: { requireBranch: 'ma?*' } };
   const gitClient = factory(Git, { options });