release-it 17.6.0 → 17.8.0

package/config/release-it.json

@@ -65,6 +65,7 @@
     "certificateAuthorityFile": null,
     "secure": null,
     "assets": null,
+    "useIdsForUrls": false,
     "origin": null,
     "skipChecks": false
   }

package/lib/config.js

@@ -2,7 +2,7 @@ import util from 'node:util';
 import { cosmiconfigSync } from 'cosmiconfig';
 import parseToml from '@iarna/toml/parse-string.js';
 import _ from 'lodash';
-import isCI from 'is-ci';
+import { isCI } from 'ci-info';
 import { readJSON, getSystemInfo } from './util.js';
 
 const debug = util.debug('release-it:config');

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

@@ -2,7 +2,6 @@ import fs from 'node:fs';
 import path from 'node:path';
 import open from 'open';
 import { Octokit } from '@octokit/rest';
-import fetch from 'node-fetch';
 import { globby } from 'globby';
 import mime from 'mime-types';
 import _ from 'lodash';
@@ -14,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
+ */
+
 const pkg = readJSON(new URL('../../../package.json', import.meta.url));
 
 const docs = 'https://git.io/release-it-github';
@@ -177,8 +180,7 @@ class GitHub extends Release {
       userAgent: `release-it/${pkg.version}`,
       log: this.config.isDebug ? console : null,
       request: {
-        timeout,
-        fetch
+        timeout
       }
     };
 
@@ -207,23 +209,36 @@ class GitHub extends Release {
 
   getOctokitReleaseOptions(options = {}) {
     const { owner, project: repo } = this.getContext('repo');
-    const { releaseName, draft = false, preRelease = false, autoGenerate = false } = 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);
     const name = format(releaseName, this.config.getContext());
     const body = autoGenerate ? (isUpdate ? null : '') : truncateBody(releaseNotes);
 
-    return Object.assign(options, {
+    /**
+     * @type {CreateReleaseOptions}
+     */
+    const contextOptions = {
       owner,
+      make_latest: makeLatest.toString(),
       repo,
       tag_name: tagName,
       name,
       body,
       draft,
       prerelease: isPreRelease || preRelease,
-      generate_release_notes: autoGenerate
-    });
+      generate_release_notes: autoGenerate,
+      discussion_category_name: discussionCategoryName
+    };
+    return Object.assign(options, contextOptions);
   }
 
   retry(fn) {
@@ -250,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/lib/plugin/github/util.js

@@ -1,10 +1,12 @@
 // Totally much borrowed from https://github.com/semantic-release/github/blob/master/lib/success.js
 import issueParser from 'issue-parser';
 
-const getSearchQueries = (base, commits, separator = '+') => {
+export const getSearchQueries = (base, commits, separator = '+') => {
+  const encodedSeparator = encodeURIComponent(separator);
+
   return commits.reduce((searches, commit) => {
     const lastSearch = searches[searches.length - 1];
-    if (lastSearch && lastSearch.length + commit.length <= 256 - separator.length) {
+    if (lastSearch && encodeURIComponent(lastSearch).length + commit.length <= 256 - encodedSeparator.length) {
       searches[searches.length - 1] = `${lastSearch}${separator}${commit}`;
     } else {
       searches.push(`${base}${separator}${commit}`);

package/lib/plugin/gitlab/GitLab.js

@@ -1,8 +1,6 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import got from 'got';
 import { globby } from 'globby';
-import { FormData, fileFromSync } from 'node-fetch';
 import _ from 'lodash';
 import Release from '../GitRelease.js';
 import { format, e } from '../../util.js';
@@ -30,22 +28,6 @@ class GitLab extends Release {
     this.certificateAuthorityOption = _.isEmpty(https) ? {} : { https };
   }
 
-  get client() {
-    if (this._client) return this._client;
-    const { tokenHeader } = this.options;
-    const { baseUrl } = this.getContext();
-    this._client = got.extend({
-      prefixUrl: baseUrl,
-      method: 'POST',
-      headers: {
-        'user-agent': 'webpro/release-it',
-        [tokenHeader]: this.token
-      },
-      ...this.certificateAuthorityOption
-    });
-    return this._client;
-  }
-
   async init() {
     await super.init();
 
@@ -179,8 +161,28 @@ class GitLab extends Release {
     const { baseUrl } = this.getContext();
     this.debug(Object.assign({ url: `${baseUrl}/${endpoint}` }, options));
     const method = (options.method || 'POST').toLowerCase();
-    const response = await this.client[method](endpoint, options);
-    const body = typeof response.body === 'string' ? JSON.parse(response.body) : response.body || {};
+    const { tokenHeader } = this.options;
+    const url = `${baseUrl}/${endpoint}${options.searchParams ? `?${new URLSearchParams(options.searchParams)}` : ''}`;
+    const headers = {
+      'user-agent': 'webpro/release-it',
+      [tokenHeader]: this.token
+    };
+    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;
   }
@@ -235,11 +237,13 @@ class GitLab extends Release {
 
   async uploadAsset(filePath) {
     const name = path.basename(filePath);
+    const { useIdsForUrls } = this.options;
     const { id, origin, repo } = this.getContext();
     const endpoint = `projects/${id}/uploads`;
 
     const body = new FormData();
-    body.set('file', fileFromSync(filePath));
+    const rawData = await fs.promises.readFile(filePath);
+    body.set('file', new Blob([rawData]), name);
     const options = { body };
 
     try {
@@ -247,7 +251,7 @@ class GitLab extends Release {
       this.log.verbose(`gitlab releases#uploadAsset: done (${body.url})`);
       this.assets.push({
         name,
-        url: `${origin}/${repo.repository}${body.url}`
+        url: useIdsForUrls ? `${origin}${body.full_path}` : `${origin}/${repo.repository}${body.url}`
       });
     } catch (err) {
       this.debug(err);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "17.6.0",
+  "version": "17.8.0",
   "description": "Generic CLI tool to automate versioning and package publishing-related tasks.",
   "keywords": [
     "build",
@@ -82,54 +82,52 @@
     "@octokit/rest": "20.1.1",
     "async-retry": "1.3.3",
     "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",
-    "got": "13.0.0",
     "inquirer": "9.3.2",
-    "is-ci": "3.0.1",
     "issue-parser": "7.0.1",
     "lodash": "4.17.21",
     "mime-types": "2.1.35",
     "new-github-release-url": "2.0.0",
-    "node-fetch": "3.3.2",
     "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": "13.5.4",
+    "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/git.json

@@ -14,7 +14,11 @@
       "default": true
     },
     "requireBranch": {
-      "type": "boolean",
+      "oneOf": [
+        { "type": "boolean", "enum": [false] },
+        { "type": "string" },
+        { "type": "array", "items": { "type": "string" } }
+      ],
       "default": false
     },
     "requireUpstream": {

package/schema/github.json

@@ -20,6 +20,10 @@
       "type": "boolean",
       "default": false
     },
+    "makeLatest": {
+      "anyOf": [{ "type": "boolean" }, { "const": "legacy" }],
+      "default": true
+    },
     "preRelease": {
       "type": "boolean",
       "default": false
@@ -28,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/schema/gitlab.json

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

package/test/config.js

@@ -1,5 +1,5 @@
 import test from 'ava';
-import isCI from 'is-ci';
+import { isCI } from 'ci-info';
 import Config from '../lib/config.js';
 import { readJSON } from '../lib/util.js';
 

package/test/github.js

@@ -2,6 +2,7 @@ import test from 'ava';
 import sinon from 'sinon';
 import { RequestError } from '@octokit/request-error';
 import GitHub from '../lib/plugin/github/GitHub.js';
+import { getSearchQueries } from '../lib/plugin/github/util.js';
 import { factory, runTasks } from './util/index.js';
 import {
   interceptAuthentication,
@@ -485,3 +486,62 @@ test.skip('should truncate long body', async t => {
   t.is(releaseUrl, 'https://github.com/user/repo/releases/tag/2.0.2');
   exec.restore();
 });
+
+test('should generate search queries correctly', t => {
+  const generateCommit = () => Math.random().toString(36).substring(2, 9);
+  const base = 'repo:owner/repo+type:pr+is:merged';
+  const commits = Array.from({ length: 5 }, generateCommit);
+  const separator = '+';
+
+  const result = getSearchQueries(base, commits, separator);
+
+  // Test case 1: Check if all commits are included in the search queries
+  const allCommitsIncluded = commits.every(commit => result.some(query => query.includes(commit)));
+  t.true(allCommitsIncluded, 'All commits should be included in the search queries');
+
+  // Test case 2: Check if the function respects the 256 character limit
+  const manyCommits = Array.from({ length: 100 }, generateCommit);
+  const longResult = getSearchQueries(base, manyCommits, separator);
+  t.true(longResult.length > 1, 'Many commits should be split into multiple queries');
+  t.true(
+    longResult.every(query => encodeURIComponent(query).length <= 256),
+    '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/gitlab.js

@@ -111,6 +111,31 @@ test.serial('should upload assets and release', async t => {
   t.is(releaseUrl, `${pushRepo}/-/releases`);
 });
 
+test.serial('should upload assets with ID-based URLs too', async t => {
+  const host = 'https://gitlab.com';
+  const pushRepo = `${host}/user/repo`;
+  const options = {
+    git: { pushRepo },
+    gitlab: {
+      tokenRef,
+      release: true,
+      assets: 'test/resources/file-v${version}.txt',
+      useIdsForUrls: true
+    }
+  };
+  const gitlab = factory(GitLab, { options });
+  sinon.stub(gitlab, 'getLatestVersion').resolves('2.0.0');
+
+  interceptUser();
+  interceptCollaborator();
+  interceptAsset();
+  interceptPublish();
+
+  await runTasks(gitlab);
+
+  t.is(gitlab.assets[0].url, `${host}/-/project/1234/uploads/7e8bec1fe27cc46a4bc6a91b9e82a07c/file-v2.0.1.txt`);
+});
+
 test.serial('should throw when release milestone is missing', async t => {
   const pushRepo = 'https://gitlab.com/user/repo';
   const options = {
@@ -226,29 +251,24 @@ test('should not make requests in dry run', async t => {
   const options = { 'dry-run': true, git: { pushRepo }, gitlab: { releaseName: 'R', tokenRef } };
   const gitlab = factory(GitLab, { options });
   sinon.stub(gitlab, 'getLatestVersion').resolves('1.0.0');
-  const spy = sinon.spy(gitlab, 'client', ['get']);
 
   await runTasks(gitlab);
 
   const { isReleased, releaseUrl } = gitlab.getContext();
-  t.is(spy.get.callCount, 0);
+
   t.is(gitlab.log.exec.args[2][0], 'gitlab releases#uploadAssets');
   t.is(gitlab.log.exec.args[3][0], 'gitlab releases#createRelease "R" (1.0.1)');
   t.true(isReleased);
   t.is(releaseUrl, `${pushRepo}/-/releases`);
-  spy.get.restore();
 });
 
 test('should skip checks', async t => {
   const options = { gitlab: { tokenRef, skipChecks: true, release: true, milestones: ['v1.0.0'] } };
   const gitlab = factory(GitLab, { options });
-  const spy = sinon.spy(gitlab, 'client', ['get']);
 
   await t.notThrowsAsync(gitlab.init());
   await t.notThrowsAsync(gitlab.beforeRelease());
 
-  t.is(spy.get.callCount, 0);
-
   t.is(gitlab.log.exec.args.filter(entry => /checkReleaseMilestones/.test(entry[0])).length, 0);
 });
 

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`, {
@@ -53,7 +62,9 @@ const interceptCreate = ({
       body,
       prerelease,
       draft,
-      generate_release_notes
+      generate_release_notes,
+      make_latest,
+      discussion_category_name
     })
     .reply(() => {
       const id = 1;
@@ -66,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}` }];
     });
@@ -77,10 +89,28 @@ 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`, { tag_name, name, body, draft, prerelease, generate_release_notes })
+    .patch(`/repos/${owner}/${project}/releases/1`, {
+      tag_name,
+      name,
+      body,
+      draft,
+      prerelease,
+      generate_release_notes,
+      make_latest,
+      discussion_category_name
+    })
     .reply(200, {
       id: 1,
       tag_name,

package/test/stub/gitlab.js

@@ -39,6 +39,7 @@ export let interceptAsset = ({ host = 'https://gitlab.com', owner = 'user', proj
       return {
         alt: name,
         url: `/uploads/7e8bec1fe27cc46a4bc6a91b9e82a07c/${name}`,
+        full_path: `/-/project/1234/uploads/7e8bec1fe27cc46a4bc6a91b9e82a07c/${name}`,
         markdown: `[${name}](/uploads/7e8bec1fe27cc46a4bc6a91b9e82a07c/${name})`
       };
     });

package/types/config.d.ts

@@ -132,6 +132,16 @@ export interface Config {
     /** @default null */
     proxy?: any;
 
+    /**
+     * @default true
+     * 'legacy' - Github determines the latest release based on the release creation date and higher semantic version.
+     * See https://docs.github.com/en/rest/releases/releases?apiVersion=latest#create-a-release
+     */
+    makeLatest?: boolean | 'legacy';
+
+    /** @default false */
+    discussionCategoryName?: boolean | string;
+
     /** @default false */
     skipChecks?: boolean;
 
@@ -170,13 +180,16 @@ export interface Config {
 
     /** @default null */
     certificateAuthorityFile?: any;
-    
+
     /** @default null */
     secure?: boolean;
 
     /** @default null */
     assets?: any;
 
+    /** @default false */
+    useIdsForUrls?: boolean;
+
     /** @default null */
     origin?: any;