release-it 17.7.0 → 17.8.0

package/lib/plugin/GitRelease.js

@@ -48,10 +48,13 @@ class GitRelease extends GitBase {
   }
 
   afterRelease() {
-    const { isReleased, releaseUrl } = this.getContext();
+    const { isReleased, releaseUrl, discussionUrl } = this.getContext();
     if (isReleased) {
       this.log.log(`🔗 ${releaseUrl}`);
     }
+    if (discussionUrl) {
+      this.log.log(`🔗 ${discussionUrl}`);
+    }
   }
 }
 

package/lib/plugin/github/GitHub.js

@@ -209,7 +209,14 @@ class GitHub extends Release {
 
   getOctokitReleaseOptions(options = {}) {
     const { owner, project: repo } = this.getContext('repo');
-    const { releaseName, draft = false, preRelease = false, autoGenerate = false, makeLatest = true } = this.options;
+    const {
+      releaseName,
+      draft = false,
+      preRelease = false,
+      autoGenerate = false,
+      makeLatest = true,
+      discussionCategoryName = false
+    } = this.options;
     const { tagName } = this.config.getContext();
     const { version, releaseNotes, isUpdate } = this.getContext();
     const { isPreRelease } = parseVersion(version);
@@ -228,7 +235,8 @@ class GitHub extends Release {
       body,
       draft,
       prerelease: isPreRelease || preRelease,
-      generate_release_notes: autoGenerate
+      generate_release_notes: autoGenerate,
+      discussion_category_name: discussionCategoryName
     };
     return Object.assign(options, contextOptions);
   }
@@ -257,9 +265,21 @@ class GitHub extends Release {
         this.debug(options);
         const response = await this.client.repos.createRelease(options);
         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 });
+        const { html_url, upload_url, id, discussion_url } = response.data;
+        this.setContext({
+          isReleased: true,
+          releaseId: id,
+          releaseUrl: html_url,
+          upload_url,
+          discussionUrl: discussion_url
+        });
+        this.config.setContext({
+          isReleased: true,
+          releaseId: id,
+          releaseUrl: html_url,
+          upload_url,
+          discussionUrl: discussion_url
+        });
         this.log.verbose(`octokit repos.createRelease: done (${response.headers.location})`);
         return response.data;
       } catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "17.7.0",
+  "version": "17.8.0",
   "description": "Generic CLI tool to automate versioning and package publishing-related tasks.",
   "keywords": [
     "build",
@@ -84,7 +84,7 @@
     "chalk": "5.3.0",
     "ci-info": "^4.0.0",
     "cosmiconfig": "9.0.0",
-    "execa": "8.0.1",
+    "execa": "8.0.0",
     "git-url-parse": "14.0.0",
     "globby": "14.0.2",
     "inquirer": "9.3.2",
@@ -93,41 +93,41 @@
     "mime-types": "2.1.35",
     "new-github-release-url": "2.0.0",
     "open": "10.1.0",
-    "ora": "8.0.1",
+    "ora": "8.1.0",
     "os-name": "5.1.0",
     "proxy-agent": "6.4.0",
-    "semver": "7.6.2",
+    "semver": "7.6.3",
     "shelljs": "0.8.5",
-    "update-notifier": "7.1.0",
+    "update-notifier": "7.3.1",
     "url-join": "5.0.0",
     "wildcard-match": "5.1.3",
     "yargs-parser": "21.1.1"
   },
   "devDependencies": {
-    "@eslint/compat": "1.1.1",
+    "@eslint/compat": "1.2.0",
     "@eslint/eslintrc": "3.1.0",
-    "@eslint/js": "9.7.0",
+    "@eslint/js": "9.12.0",
     "@octokit/request-error": "5.1.0",
     "@types/node": "20.14.10",
     "ava": "6.1.3",
-    "eslint": "9.7.0",
+    "eslint": "9.12.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-ava": "15.0.1",
-    "eslint-plugin-import-x": "3.0.1",
-    "eslint-plugin-prettier": "5.1.3",
+    "eslint-plugin-import-x": "4.3.1",
+    "eslint-plugin-prettier": "5.2.1",
     "fs-monkey": "1.0.6",
-    "globals": "15.8.0",
+    "globals": "15.10.0",
     "installed-check": "9.3.0",
-    "knip": "5.26.0",
-    "memfs": "4.9.3",
+    "knip": "5.31.0",
+    "memfs": "4.12.0",
     "mock-stdio": "1.0.3",
     "nock": "14.0.0-beta.8",
     "prettier": "3.3.3",
     "remark-cli": "12.0.1",
-    "remark-preset-webpro": "1.1.0",
-    "sinon": "18.0.0",
+    "remark-preset-webpro": "1.1.1",
+    "sinon": "19.0.2",
     "strip-ansi": "7.1.0",
-    "typescript": "5.5.3"
+    "typescript": "5.6.2"
   },
   "overrides": {
     "pac-resolver": "7.0.1",

package/schema/github.json

@@ -32,6 +32,10 @@
       "type": "boolean",
       "default": false
     },
+    "discussionCategoryName": {
+      "$comment": "Add discussion to the GitHub discussion for the Release",
+      "type": "string"
+    },
     "tokenRef": {
       "type": "string",
       "default": "GITHUB_TOKEN"

package/test/github.js

@@ -508,3 +508,40 @@ test('should generate search queries correctly', t => {
     'Each query should not exceed 256 characters after encoding'
   );
 });
+
+test('should create auto-generated discussion', async t => {
+  const options = {
+    git,
+    github: {
+      pushRepo,
+      tokenRef,
+      release: true,
+      releaseName: 'Release ${tagName}',
+      autoGenerate: false,
+      discussionCategoryName: 'Announcement'
+    }
+  };
+  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',
+      generate_release_notes: false,
+      body: null,
+      discussion_category_name: 'Announcement'
+    }
+  });
+
+  await runTasks(github);
+
+  const { isReleased, releaseUrl, discussionUrl } = github.getContext();
+  t.true(isReleased);
+  t.is(releaseUrl, 'https://github.com/user/repo/releases/tag/2.0.2');
+  t.is(discussionUrl, 'https://github.com/user/repo/discussions/1');
+  exec.restore();
+});

package/test/stub/github.js

@@ -44,7 +44,16 @@ const interceptCreate = ({
   host = 'github.com',
   owner = 'user',
   project = 'repo',
-  body: { tag_name, name = '', generate_release_notes = false, body = null, prerelease = false, draft = false }
+  body: {
+    tag_name,
+    name = '',
+    body = null,
+    prerelease = false,
+    draft = false,
+    generate_release_notes = false,
+    make_latest = 'true',
+    discussion_category_name = false
+  }
 } = {}) => {
   nock(api)
     .post(`/repos/${owner}/${project}/releases`, {
@@ -54,7 +63,8 @@ const interceptCreate = ({
       prerelease,
       draft,
       generate_release_notes,
-      make_latest: 'true'
+      make_latest,
+      discussion_category_name
     })
     .reply(() => {
       const id = 1;
@@ -67,7 +77,8 @@ const interceptCreate = ({
         draft,
         generate_release_notes,
         upload_url: `https://uploads.${host}/repos/${owner}/${project}/releases/${id}/assets{?name,label}`,
-        html_url: `https://${host}/${owner}/${project}/releases/tag/${tag_name}`
+        html_url: `https://${host}/${owner}/${project}/releases/tag/${tag_name}`,
+        discussion_url: discussion_category_name ? `https://${host}/${owner}/${project}/discussions/${id}` : undefined
       };
       return [200, responseBody, { location: `${api}/repos/${owner}/${project}/releases/${id}` }];
     });
@@ -78,7 +89,16 @@ const interceptUpdate = ({
   api = 'https://api.github.com',
   owner = 'user',
   project = 'repo',
-  body: { tag_name, name = '', body = null, prerelease = false, draft = false, generate_release_notes = false }
+  body: {
+    tag_name,
+    name = '',
+    body = null,
+    prerelease = false,
+    draft = false,
+    generate_release_notes = false,
+    make_latest = 'true',
+    discussion_category_name = false
+  }
 } = {}) => {
   nock(api)
     .patch(`/repos/${owner}/${project}/releases/1`, {
@@ -88,7 +108,8 @@ const interceptUpdate = ({
       draft,
       prerelease,
       generate_release_notes,
-      make_latest: 'true'
+      make_latest,
+      discussion_category_name
     })
     .reply(200, {
       id: 1,

package/types/config.d.ts

@@ -139,6 +139,9 @@ export interface Config {
      */
     makeLatest?: boolean | 'legacy';
 
+    /** @default false */
+    discussionCategoryName?: boolean | string;
+
     /** @default false */
     skipChecks?: boolean;