release-it 18.0.0-next.4 → 18.1.0

package/README.md

@@ -44,7 +44,7 @@ npm install -D release-it
     "release": "release-it"
   },
   "devDependencies": {
-    "release-it": "^16.1.0"
+    "release-it": "^18.0.0"
   }
 }
 ```
@@ -99,7 +99,7 @@ Here's a quick example `.release-it.json`:
 
 ```json
 {
-  "$schema": "https://unpkg.com/release-it@17/schema/release-it.json",
+  "$schema": "https://unpkg.com/release-it@18/schema/release-it.json",
   "git": {
     "commitMessage": "chore: release v${version}"
   },
@@ -344,10 +344,18 @@ release-it programmatically][54] for example code.
 - [Repositories that depend on release-it][76]
 - GitHub search for [path:\*\*/.release-it.json][77]
 
-## Legacy Node.js
+## Node.js version support
 
-The latest major version is v17, supporting Node.js 18 and up (as Node.js v16 is EOL). The previous major version was
-v16, supporting Node.js 16. Use release-it v15 for environments running Node.js v14. Also see [CHANGELOG.md][78].
+The latest major version is v18, supporting Node.js 20 and up:
+
+| release-it | Node.js |
+| :--------: | :-----: |
+|    v18     |   v20   |
+|    v17     |   v18   |
+|    v16     |   v16   |
+|    v15     |   v14   |
+
+Also see [CHANGELOG.md][78] for dates and details.
 
 ## Links
 

package/lib/plugin/GitRelease.js

@@ -31,7 +31,8 @@ class GitRelease extends GitBase {
   async beforeRelease() {
     const { releaseNotes: script } = this.options;
     const { changelog } = this.config.getContext();
-    const releaseNotes = script ? await this.processReleaseNotes(script) : changelog;
+    const releaseNotes =
+      typeof script === 'function' || typeof script === 'string' ? await this.processReleaseNotes(script) : changelog;
     this.setContext({ releaseNotes });
     if (releaseNotes !== changelog) {
       this.log.preview({ title: 'release notes', text: releaseNotes });
@@ -42,7 +43,9 @@ class GitRelease extends GitBase {
     if (typeof script === 'function') {
       const ctx = Object.assign({}, this.config.getContext(), { [this.namespace]: this.getContext() });
       return script(ctx);
-    } else {
+    }
+
+    if (typeof script === 'string') {
       return this.exec(script);
     }
   }

package/lib/plugin/github/GitHub.js

@@ -211,7 +211,7 @@ class GitHub extends Release {
     }
   }
 
-  getOctokitReleaseOptions(options = {}) {
+  async getOctokitReleaseOptions(options = {}) {
     const { owner, project: repo } = this.getContext('repo');
     const {
       releaseName,
@@ -225,7 +225,12 @@ class GitHub extends Release {
     const { version, releaseNotes, isUpdate } = this.getContext();
     const { isPreRelease } = parseVersion(version);
     const name = format(releaseName, this.config.getContext());
-    const body = autoGenerate ? (isUpdate ? null : '') : truncateBody(releaseNotes);
+    const releaseNotesObject = this.options.releaseNotes;
+    const body = autoGenerate
+      ? isUpdate
+        ? null
+        : ''
+      : truncateBody(releaseNotesObject?.commit ? await this.renderReleaseNotes(releaseNotesObject) : releaseNotes);
 
     /**
      * @type {CreateReleaseOptions}
@@ -254,7 +259,7 @@ class GitHub extends Release {
   }
 
   async createRelease() {
-    const options = this.getOctokitReleaseOptions();
+    const options = await this.getOctokitReleaseOptions();
     const { isDryRun } = this.config;
 
     this.log.exec(`octokit repos.createRelease "${options.name}" (${options.tag_name})`, { isDryRun });
@@ -350,11 +355,11 @@ class GitHub extends Release {
     return `https://${host}/${repository}/releases/tag/${tagName}`;
   }
 
-  generateWebUrl() {
+  async generateWebUrl() {
     const host = this.options.host || this.getContext('repo.host');
     const isGitHub = host === 'github.com';
 
-    const options = this.getOctokitReleaseOptions();
+    const options = await this.getOctokitReleaseOptions();
     const url = newGithubReleaseUrl({
       user: options.owner,
       repo: options.repo,
@@ -369,7 +374,7 @@ class GitHub extends Release {
   async createWebRelease() {
     const { isCI } = this.config;
     const { tagName } = this.config.getContext();
-    const url = this.generateWebUrl();
+    const url = await this.generateWebUrl();
     if (isCI) {
       this.setContext({ isReleased: true, releaseUrl: url });
     } else {
@@ -380,10 +385,10 @@ class GitHub extends Release {
     }
   }
 
-  updateRelease() {
+  async updateRelease() {
     const { isDryRun } = this.config;
     const release_id = this.getContext('releaseId');
-    const options = this.getOctokitReleaseOptions({ release_id });
+    const options = await this.getOctokitReleaseOptions({ release_id });
 
     this.log.exec(`octokit repos.updateRelease (${options.tag_name})`, { isDryRun });
 
@@ -438,6 +443,30 @@ class GitHub extends Release {
       }
     }
   }
+
+  async getCommits() {
+    const { owner, project: repo } = this.getContext('repo');
+    const { latestTag } = this.config.getContext();
+    this.debug({ owner, repo, base: latestTag, head: 'HEAD' });
+    const { data } = await this.client.repos.compareCommits({ owner, repo, base: latestTag, head: 'HEAD' });
+    return data.commits;
+  }
+
+  async renderReleaseNotes(releaseNotes) {
+    const { commit: template, excludeMatches = [] } = releaseNotes;
+    const commits = await this.getCommits();
+
+    return commits
+      .map(commit => {
+        commit.commit.subject = commit.commit.message.split('\n')[0];
+        const partial = template.replace(/(?<!\$)\{((?:[^{}]|\${[^}]+})+)\}/g, (_, block) => {
+          const rendered = format(block, commit);
+          return excludeMatches.some(match => rendered.includes(match)) ? '' : rendered;
+        });
+        return format(partial, commit);
+      })
+      .join('\n');
+  }
 }
 
 export default GitHub;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "18.0.0-next.4",
+  "version": "18.1.0",
   "description": "Generic CLI tool to automate versioning and package publishing-related tasks.",
   "keywords": [
     "build",
@@ -69,7 +69,7 @@
     "lint": "eslint lib test",
     "format": "prettier --write eslint.config.mjs \"{lib,test}/**/*.js\"",
     "docs": "remark README.md 'docs/**/*.md' '.github/*.md' -o",
-    "test": "ava --no-worker-threads && installed-check",
+    "test": "ava --no-worker-threads && installed-check --ignore ava",
     "release": "./bin/release-it.js"
   },
   "author": {
@@ -108,8 +108,8 @@
     "@eslint/compat": "1.2.4",
     "@eslint/eslintrc": "3.2.0",
     "@eslint/js": "9.17.0",
-    "@octokit/request-error": "6.1.5",
-    "@types/node": "20.16.10",
+    "@octokit/request-error": "6.1.6",
+    "@types/node": "20.17.11",
     "ava": "6.2.0",
     "eslint": "9.17.0",
     "eslint-config-prettier": "9.1.0",
@@ -120,7 +120,7 @@
     "globals": "15.14.0",
     "installed-check": "9.3.0",
     "knip": "5.41.1",
-    "memfs": "4.15.1",
+    "memfs": "4.15.3",
     "mock-stdio": "1.0.3",
     "nock": "14.0.0-beta.8",
     "prettier": "3.4.2",
@@ -135,7 +135,7 @@
     "socks": "2.8.3"
   },
   "engines": {
-    "node": "^20.9.0 || ^22.0.0"
+    "node": "^20.9.0 || >=22.0.0"
   },
   "remarkConfig": {
     "plugins": [

package/schema/github.json

@@ -14,6 +14,24 @@
       "default": "Release ${version}"
     },
     "releaseNotes": {
+      "anyOf": [
+        { "type": ["string", "null"] },
+        {
+          "type": "object",
+          "properties": {
+            "commit": {
+              "type": "string"
+            },
+            "excludeMatches": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "default": []
+            }
+          }
+        }
+      ],
       "default": null
     },
     "autoGenerate": {

package/types/config.d.ts

@@ -106,7 +106,7 @@ export interface Config {
     releaseName?: string;
 
     /** @default null */
-    releaseNotes?: any;
+    releaseNotes?: string | null | (() => string | Promise<string>) | { commit?: string; excludeMatches?: string[] };
 
     /** @default false */
     autoGenerate?: boolean;