release-it 15.8.0 → 15.9.1

package/README.md

@@ -347,8 +347,11 @@ While mostly used as a CLI tool, release-it can be used as a dependency to integ
 - [js-cookie/js-cookie](https://github.com/js-cookie/js-cookie)
 - [metalsmith/metalsmith](https://github.com/metalsmith/metalsmith)
 - [mozilla/readability](https://github.com/mozilla/readability)
+- [pahen/madge](https://github.com/pahen/madge)
 - [redis/node-redis](https://github.com/redis/node-redis)
+- [reduxjs/redux](https://github.com/reduxjs/redux)
 - [saleor/saleor](https://github.com/saleor/saleor)
+- [Semantic-Org/Semantic-UI-React](https://github.com/Semantic-Org/Semantic-UI-React)
 - [shipshapecode/shepherd](https://github.com/shipshapecode/shepherd)
 - [StevenBlack/hosts](https://github.com/StevenBlack/hosts)
 - [swagger-api/swagger-ui](https://github.com/swagger-api/swagger-ui) +
@@ -356,7 +359,7 @@ While mostly used as a CLI tool, release-it can be used as a dependency to integ
 - [tabler/tabler](https://github.com/tabler/tabler) + [tabler-icons](https://github.com/tabler/tabler-icons)
 - [youzan/vant](https://github.com/youzan/vant)
 - [Repositories that depend on release-it](https://github.com/release-it/release-it/network/dependents)
-- GitHub search for [filename:.release-it.json](https://github.com/search?q=filename%3A.release-it.json)
+- GitHub search for [path:\*\*/.release-it.json](https://github.com/search?q=path%3A**%2F.release-it.json&type=code)
 
 ## License
 

package/lib/plugin/GitRelease.js

@@ -24,13 +24,22 @@ class GitRelease extends GitBase {
   async beforeRelease() {
     const { releaseNotes: script } = this.options;
     const { changelog } = this.config.getContext();
-    const releaseNotes = script ? await this.exec(script) : changelog;
+    const releaseNotes = script ? await this.processReleaseNotes(script) : changelog;
     this.setContext({ releaseNotes });
     if (releaseNotes !== changelog) {
       this.log.preview({ title: 'release notes', text: releaseNotes });
     }
   }
 
+  async processReleaseNotes(script) {
+    if (typeof script === 'function') {
+      const ctx = Object.assign({}, this.config.getContext(), { [this.namespace]: this.getContext() });
+      return script(ctx);
+    } else {
+      return this.exec(script);
+    }
+  }
+
   afterRelease() {
     const { isReleased, releaseUrl } = this.getContext();
     if (isReleased) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "15.8.0",
+  "version": "15.9.1",
   "description": "Generic CLI tool to automate versioning and package publishing related tasks.",
   "keywords": [
     "build",
@@ -63,19 +63,19 @@
     "@octokit/rest": "19.0.7",
     "async-retry": "1.3.3",
     "chalk": "5.2.0",
-    "cosmiconfig": "8.1.0",
-    "execa": "7.0.0",
+    "cosmiconfig": "8.1.3",
+    "execa": "7.1.1",
     "git-url-parse": "13.1.0",
     "globby": "13.1.3",
     "got": "12.6.0",
-    "inquirer": "9.1.4",
+    "inquirer": "9.1.5",
     "is-ci": "3.0.1",
     "lodash": "4.17.21",
     "mime-types": "2.1.35",
     "new-github-release-url": "2.0.0",
-    "node-fetch": "3.3.0",
-    "open": "8.4.2",
-    "ora": "6.1.2",
+    "node-fetch": "3.3.1",
+    "open": "9.0.0",
+    "ora": "6.2.0",
     "os-name": "5.1.0",
     "promise.allsettled": "1.0.6",
     "proxy-agent": "5.0.0",
@@ -89,8 +89,8 @@
   "devDependencies": {
     "@octokit/request-error": "3.0.3",
     "ava": "5.2.0",
-    "eslint": "8.35.0",
-    "eslint-config-prettier": "8.7.0",
+    "eslint": "8.36.0",
+    "eslint-config-prettier": "8.8.0",
     "eslint-plugin-ava": "14.0.0",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-prettier": "4.2.1",
@@ -98,8 +98,8 @@
     "mock-stdio": "1.0.3",
     "nock": "13.3.0",
     "nyc": "15.1.0",
-    "prettier": "2.8.4",
-    "sinon": "15.0.1",
+    "prettier": "2.8.6",
+    "sinon": "15.0.2",
     "strip-ansi": "7.0.1"
   },
   "engines": {

package/test/github.js

@@ -164,6 +164,35 @@ test('should update release and upload assets', async t => {
   exec.restore();
 });
 
+test('should create custom release notes using releaseNotes function', async t => {
+  const options = {
+    git,
+    github: {
+      pushRepo,
+      tokenRef,
+      release: true,
+      releaseName: 'Release ${tagName}',
+      releaseNotes(context) {
+        return `Custom notes for tag ${context.tagName}`;
+      }
+    }
+  };
+  const github = factory(GitHub, { options });
+  const exec = sinon.stub(github.shell, 'exec').callThrough();
+  exec.withArgs('git describe --tags --match=* --abbrev=0').resolves('2.0.1');
+
+  interceptAuthentication();
+  interceptCollaborator();
+  interceptCreate({ body: { tag_name: '2.0.2', name: 'Release 2.0.2', body: 'Custom notes for tag 2.0.2' } });
+
+  await runTasks(github);
+
+  const { isReleased, releaseUrl } = github.getContext();
+  t.true(isReleased);
+  t.is(releaseUrl, 'https://github.com/user/repo/releases/tag/2.0.2');
+  exec.restore();
+});
+
 test('should create new release for unreleased tag', async t => {
   const options = {
     increment: false,