release-it 18.0.0-next.3 → 18.0.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}"
   },
@@ -181,6 +181,7 @@ message conventions. Plugins are available for:
 - auto-changelog
 - Conventional Changelog
 - Keep A Changelog
+- git-cliff
 
 To print the changelog without releasing anything, add the `--changelog` flag.
 
@@ -328,34 +329,43 @@ release-it programmatically][54] for example code.
 - [Halo][59]
 - [hosts][60]
 - [js-cookie][61]
-- [Madge][62]
-- [Metalsmith][63]
-- [Node-Redis][64]
-- [React Native Paper][65]
-- [Readability.js][66]
-- [Redux][67]
-- [Saleor][68]
-- [Semantic UI React][69]
-- [Shepherd][70]
-- [Tabler][71] + [tabler-icons][72]
-- Swagger ([swagger-ui][73] + [swagger-editor][74])
-- [Repositories that depend on release-it][75]
-- GitHub search for [path:\*\*/.release-it.json][76]
-
-## Legacy Node.js
-
-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][77].
+- [jQuery][62]
+- [Madge][63]
+- [Metalsmith][64]
+- [Node-Redis][65]
+- [React Native Paper][66]
+- [Readability.js][67]
+- [Redux][68]
+- [Saleor][69]
+- [Semantic UI React][70]
+- [Shepherd][71]
+- [Tabler][72] + [tabler-icons][73]
+- Swagger ([swagger-ui][74] + [swagger-editor][75])
+- [Repositories that depend on release-it][76]
+- GitHub search for [path:\*\*/.release-it.json][77]
+
+## Node.js version support
+
+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
 
-- See [CHANGELOG.md][77] for major/breaking updates, and [releases][78] for a detailed version history.
-- To **contribute**, please read [CONTRIBUTING.md][79] first.
-- Please [open an issue][80] if anything is missing or unclear in this documentation.
+- See [CHANGELOG.md][78] for major/breaking updates, and [releases][79] for a detailed version history.
+- To **contribute**, please read [CONTRIBUTING.md][80] first.
+- Please [open an issue][81] if anything is missing or unclear in this documentation.
 
 ## License
 
-[MIT][81]
+[MIT][82]
 
 Are you using release-it at work? Please consider [sponsoring me][14]!
 
@@ -420,23 +430,24 @@ Are you using release-it at work? Please consider [sponsoring me][14]!
 [59]: https://github.com/halo-dev/halo
 [60]: https://github.com/StevenBlack/hosts
 [61]: https://github.com/js-cookie/js-cookie
-[62]: https://github.com/pahen/madge
-[63]: https://github.com/metalsmith/metalsmith
-[64]: https://github.com/redis/node-redis
-[65]: https://github.com/callstack/react-native-paper
-[66]: https://github.com/mozilla/readability
-[67]: https://github.com/reduxjs/redux
-[68]: https://github.com/saleor/saleor
-[69]: https://github.com/Semantic-Org/Semantic-UI-React
-[70]: https://github.com/shipshapecode/shepherd
-[71]: https://github.com/tabler/tabler
-[72]: https://github.com/tabler/tabler-icons
-[73]: https://github.com/swagger-api/swagger-ui
-[74]: https://github.com/swagger-api/swagger-editor
-[75]: https://github.com/release-it/release-it/network/dependents
-[76]: https://github.com/search?q=path%3A**%2F.release-it.json&type=code
-[77]: ./CHANGELOG.md
-[78]: https://github.com/release-it/release-it/releases
-[79]: ./.github/CONTRIBUTING.md
-[80]: https://github.com/release-it/release-it/issues/new
-[81]: ./LICENSE
+[62]: https://github.com/jquery/jquery
+[63]: https://github.com/pahen/madge
+[64]: https://github.com/metalsmith/metalsmith
+[65]: https://github.com/redis/node-redis
+[66]: https://github.com/callstack/react-native-paper
+[67]: https://github.com/mozilla/readability
+[68]: https://github.com/reduxjs/redux
+[69]: https://github.com/saleor/saleor
+[70]: https://github.com/Semantic-Org/Semantic-UI-React
+[71]: https://github.com/shipshapecode/shepherd
+[72]: https://github.com/tabler/tabler
+[73]: https://github.com/tabler/tabler-icons
+[74]: https://github.com/swagger-api/swagger-ui
+[75]: https://github.com/swagger-api/swagger-editor
+[76]: https://github.com/release-it/release-it/network/dependents
+[77]: https://github.com/search?q=path%3A**%2F.release-it.json&type=code
+[78]: ./CHANGELOG.md
+[79]: https://github.com/release-it/release-it/releases
+[80]: ./.github/CONTRIBUTING.md
+[81]: https://github.com/release-it/release-it/issues/new
+[82]: ./LICENSE

package/config/release-it.json

@@ -65,6 +65,9 @@
     "certificateAuthorityFile": null,
     "secure": null,
     "assets": null,
+    "useIdsForUrls": false,
+    "useGenericPackageRepositoryForAssets": false,
+    "genericPackageRepositoryName": "release-it",
     "origin": null,
     "skipChecks": false
   }

package/lib/plugin/GitBase.js

@@ -27,7 +27,7 @@ class GitBase extends Plugin {
 
   getLatestVersion() {
     const { tagTemplate, latestTag } = this.config.getContext();
-    const prefix = tagTemplate.replace(/\$\{version\}/, '');
+    const prefix = format(tagTemplate.replace(/\$\{version\}/, ''), this.config.getContext());
     return latestTag ? latestTag.replace(prefix, '').replace(/^v/, '') : null;
   }
 

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

@@ -13,6 +13,10 @@ import Release from '../GitRelease.js';
 import prompts from './prompts.js';
 import { getCommitsFromChangelog, getResolvedIssuesFromChangelog, searchQueries } from './util.js';
 
+/**
+ * @typedef {import('@octokit/rest').RestEndpointMethodTypes['repos']['createRelease']['parameters']} CreateReleaseOptions
+ */
+
 /**
  * @typedef {import('@octokit/rest').RestEndpointMethodTypes['repos']['createRelease']['parameters']} CreateReleaseOptions
  */
@@ -209,7 +213,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 = undefined
+    } = this.options;
     const { tagName } = this.config.getContext();
     const { version, releaseNotes, isUpdate } = this.getContext();
     const { isPreRelease } = parseVersion(version);
@@ -228,7 +239,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 +269,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/lib/plugin/gitlab/GitLab.js

@@ -2,6 +2,7 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { globby } from 'globby';
 import _ from 'lodash';
+import { Agent } from 'undici';
 import Release from '../GitRelease.js';
 import { format, e } from '../../util.js';
 import prompts from './prompts.js';
@@ -16,16 +17,18 @@ class GitLab extends Release {
     this.registerPrompts(prompts);
     this.assets = [];
     const { certificateAuthorityFile, secure } = this.options;
+    this.certificateAuthorityOption = {};
 
-    const httpsOptions = {
-      certificateAuthority: certificateAuthorityFile ? fs.readFileSync(certificateAuthorityFile) : undefined,
-      rejectUnauthorized: typeof secure === 'boolean' ? secure : undefined
-    };
-
-    // Remove keys with undefined values
-    const https = _.pickBy(httpsOptions, value => value !== undefined);
+    const needsCustomAgent = Boolean(secure === false || certificateAuthorityFile);
 
-    this.certificateAuthorityOption = _.isEmpty(https) ? {} : { https };
+    if (needsCustomAgent) {
+      this.certificateAuthorityOption.dispatcher = new Agent({
+        connect: {
+          rejectUnauthorized: secure,
+          ca: certificateAuthorityFile ? fs.readFileSync(certificateAuthorityFile) : undefined
+        }
+      });
+    }
   }
 
   async init() {
@@ -167,34 +170,51 @@ class GitLab extends Release {
       'user-agent': 'webpro/release-it',
       [tokenHeader]: this.token
     };
+    // When using fetch() with FormData bodies, we should not set the Content-Type header.
+    // See: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest_API/Using_FormData_Objects#sending_files_using_a_formdata_object
+    if (!(options.body instanceof FormData)) {
+      headers['Content-Type'] = typeof options.json !== 'undefined' ? 'application/json' : 'text/plain';
+    }
     const requestOptions = {
       method,
       headers,
       ...this.certificateAuthorityOption
     };
 
-    const response = await fetch(
-      url,
-      options.json || options.body
-        ? {
-            ...requestOptions,
-            body: options.json ? JSON.stringify(options.json) : options.body
-          }
-        : requestOptions
-    );
-    const body = await response.json();
-    this.debug(body);
-    return body;
+    try {
+      const response = await fetch(
+        url,
+        options.json || options.body
+          ? {
+              ...requestOptions,
+              body: options.json ? JSON.stringify(options.json) : options.body
+            }
+          : requestOptions
+      );
+
+      if (!response.ok) {
+        const body = await response.json();
+        throw new Error(body.error);
+      }
+
+      const body = await response.json();
+      this.debug(body);
+      return body;
+    } catch (err) {
+      this.debug(err);
+      throw err;
+    }
   }
 
   async createRelease() {
     const { releaseName } = this.options;
-    const { tagName } = this.config.getContext();
+    const { tagName, branchName, git: { tagAnnotation } = {} } = this.config.getContext();
     const { id, releaseNotes, repo, origin } = this.getContext();
     const { isDryRun } = this.config;
     const name = format(releaseName, this.config.getContext());
+    const tagMessage = format(tagAnnotation, this.config.getContext());
     const description = releaseNotes || '-';
-    const releaseUrl = `${origin}/${repo.repository}/-/releases`;
+    const releaseUrl = `${origin}/${repo.repository}/-/releases/${tagName}`;
     const releaseMilestones = this.getReleaseMilestones();
 
     this.log.exec(`gitlab releases#createRelease "${name}" (${tagName})`, { isDryRun });
@@ -208,7 +228,9 @@ class GitLab extends Release {
     const options = {
       json: {
         name,
+        ref: branchName,
         tag_name: tagName,
+        tag_message: tagMessage,
         description
       }
     };
@@ -224,10 +246,11 @@ class GitLab extends Release {
     }
 
     try {
-      await this.request(endpoint, options);
+      const body = await this.request(endpoint, options);
+      const releaseUrlSelf = body._links?.self ?? releaseUrl;
       this.log.verbose('gitlab releases#createRelease: done');
-      this.setContext({ isReleased: true, releaseUrl });
-      this.config.setContext({ isReleased: true, releaseUrl });
+      this.setContext({ isReleased: true, releaseUrl: releaseUrlSelf });
+      this.config.setContext({ isReleased: true, releaseUrl: releaseUrlSelf });
       return true;
     } catch (err) {
       this.debug(err);
@@ -237,24 +260,47 @@ class GitLab extends Release {
 
   async uploadAsset(filePath) {
     const name = path.basename(filePath);
-    const { id, origin, repo } = this.getContext();
-    const endpoint = `projects/${id}/uploads`;
-
-    const body = new FormData();
-    const rawData = await fs.promises.readFile(filePath);
-    body.set('file', new Blob([rawData]), name);
-    const options = { body };
-
-    try {
-      const body = await this.request(endpoint, options);
-      this.log.verbose(`gitlab releases#uploadAsset: done (${body.url})`);
-      this.assets.push({
-        name,
-        url: `${origin}/${repo.repository}${body.url}`
-      });
-    } catch (err) {
-      this.debug(err);
-      throw err;
+    const { useIdsForUrls, useGenericPackageRepositoryForAssets, genericPackageRepositoryName } = this.options;
+    const { id, origin, repo, version, baseUrl } = this.getContext();
+    const endpoint = useGenericPackageRepositoryForAssets
+      ? `projects/${id}/packages/generic/${genericPackageRepositoryName}/${version}/${name}`
+      : `projects/${id}/uploads`;
+    if (useGenericPackageRepositoryForAssets) {
+      const options = {
+        method: 'PUT',
+        body: await fs.promises.readFile(filePath)
+      };
+      try {
+        const body = await this.request(endpoint, options);
+        if (!(body.message && body.message == '201 Created')) {
+          throw new Error(`GitLab asset upload failed`);
+        }
+        this.log.verbose(`gitlab releases#uploadAsset: done (${endpoint})`);
+        this.assets.push({
+          name,
+          url: `${baseUrl}/${endpoint}`
+        });
+      } catch (err) {
+        this.debug(err);
+        throw err;
+      }
+    } else {
+      const body = new FormData();
+      const rawData = await fs.promises.readFile(filePath);
+      body.set('file', new Blob([rawData]), name);
+      const options = { body };
+
+      try {
+        const body = await this.request(endpoint, options);
+        this.log.verbose(`gitlab releases#uploadAsset: done (${body.url})`);
+        this.assets.push({
+          name,
+          url: useIdsForUrls ? `${origin}${body.full_path}` : `${origin}/${repo.repository}${body.url}`
+        });
+      } catch (err) {
+        this.debug(err);
+        throw err;
+      }
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "18.0.0-next.3",
+  "version": "18.0.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": {
@@ -81,60 +81,61 @@
     "@iarna/toml": "2.2.5",
     "@octokit/rest": "21.0.2",
     "async-retry": "1.3.3",
-    "chalk": "5.3.0",
-    "ci-info": "^4.0.0",
+    "chalk": "5.4.1",
+    "ci-info": "^4.1.0",
     "cosmiconfig": "9.0.0",
-    "execa": "9.4.0",
-    "git-url-parse": "15.0.0",
+    "execa": "9.5.2",
+    "git-url-parse": "16.0.0",
     "globby": "14.0.2",
-    "inquirer": "11.0.2",
+    "inquirer": "12.3.0",
     "issue-parser": "7.0.1",
     "lodash": "4.17.21",
     "mime-types": "2.1.35",
     "new-github-release-url": "2.0.0",
     "open": "10.1.0",
-    "ora": "8.1.0",
+    "ora": "8.1.1",
     "os-name": "6.0.0",
-    "proxy-agent": "6.4.0",
+    "proxy-agent": "6.5.0",
     "semver": "7.6.3",
     "shelljs": "0.8.5",
+    "undici": "6.21.0",
     "update-notifier": "7.3.1",
     "url-join": "5.0.0",
-    "wildcard-match": "5.1.3",
+    "wildcard-match": "5.1.4",
     "yargs-parser": "21.1.1"
   },
   "devDependencies": {
-    "@eslint/compat": "1.1.1",
-    "@eslint/eslintrc": "3.1.0",
-    "@eslint/js": "9.11.0",
-    "@octokit/request-error": "6.1.4",
-    "@types/node": "22.5.5",
-    "ava": "6.1.3",
-    "eslint": "9.11.0",
+    "@eslint/compat": "1.2.4",
+    "@eslint/eslintrc": "3.2.0",
+    "@eslint/js": "9.17.0",
+    "@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",
     "eslint-plugin-ava": "15.0.1",
-    "eslint-plugin-import-x": "4.2.1",
+    "eslint-plugin-import-x": "4.6.1",
     "eslint-plugin-prettier": "5.2.1",
     "fs-monkey": "1.0.6",
-    "globals": "15.9.0",
+    "globals": "15.14.0",
     "installed-check": "9.3.0",
-    "knip": "5.30.2",
-    "memfs": "4.12.0",
+    "knip": "5.41.1",
+    "memfs": "4.15.3",
     "mock-stdio": "1.0.3",
     "nock": "14.0.0-beta.8",
-    "prettier": "3.3.3",
+    "prettier": "3.4.2",
     "remark-cli": "12.0.1",
-    "remark-preset-webpro": "1.1.0",
+    "remark-preset-webpro": "1.1.1",
     "sinon": "19.0.2",
     "strip-ansi": "7.1.0",
-    "typescript": "5.6.2"
+    "typescript": "5.7.2"
   },
   "overrides": {
     "pac-resolver": "7.0.1",
     "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

@@ -32,6 +32,10 @@
       "type": "boolean",
       "default": false
     },
+    "discussionCategoryName": {
+      "$comment": "Create discussion of the specified category and link to the GitHub Release",
+      "type": "string"
+    },
     "tokenRef": {
       "type": "string",
       "default": "GITHUB_TOKEN"

package/schema/gitlab.json

@@ -28,7 +28,7 @@
       "type": "boolean",
       "default": false
     },
-    "milesstones": {
+    "milestones": {
       "type": "array",
       "items": {
         "type": "string"
@@ -52,6 +52,18 @@
     "assets": {
       "default": null
     },
+    "useIdsForUrls": {
+      "type": "boolean",
+      "default": false
+    },
+    "useGenericPackageRepositoryForAssets": {
+      "type": "boolean",
+      "default": false
+    },
+    "genericPackageRepositoryName": {
+       "type": "string",
+       "default": "release-it"
+    },
     "origin": {
       "type": "string",
       "default": null

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();
+});