release-it 18.0.0-next.1 → 18.0.0-next.3

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
+ */
+
 const pkg = readJSON(new URL('../../../package.json', import.meta.url));
 
 const docs = 'https://git.io/release-it-github';
@@ -205,15 +209,19 @@ 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 } = 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,
@@ -221,7 +229,8 @@ class GitHub extends Release {
       draft,
       prerelease: isPreRelease || preRelease,
       generate_release_notes: autoGenerate
-    });
+    };
+    return Object.assign(options, contextOptions);
   }
 
   retry(fn) {

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "18.0.0-next.1",
+  "version": "18.0.0-next.3",
   "description": "Generic CLI tool to automate versioning and package publishing-related tasks.",
   "keywords": [
     "build",
@@ -84,10 +84,10 @@
     "chalk": "5.3.0",
     "ci-info": "^4.0.0",
     "cosmiconfig": "9.0.0",
-    "execa": "9.3.1",
+    "execa": "9.4.0",
     "git-url-parse": "15.0.0",
     "globby": "14.0.2",
-    "inquirer": "10.2.2",
+    "inquirer": "11.0.2",
     "issue-parser": "7.0.1",
     "lodash": "4.17.21",
     "mime-types": "2.1.35",
@@ -106,11 +106,11 @@
   "devDependencies": {
     "@eslint/compat": "1.1.1",
     "@eslint/eslintrc": "3.1.0",
-    "@eslint/js": "9.10.0",
+    "@eslint/js": "9.11.0",
     "@octokit/request-error": "6.1.4",
-    "@types/node": "22.5.4",
+    "@types/node": "22.5.5",
     "ava": "6.1.3",
-    "eslint": "9.10.0",
+    "eslint": "9.11.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-ava": "15.0.1",
     "eslint-plugin-import-x": "4.2.1",
@@ -118,14 +118,14 @@
     "fs-monkey": "1.0.6",
     "globals": "15.9.0",
     "installed-check": "9.3.0",
-    "knip": "5.30.1",
-    "memfs": "4.11.1",
+    "knip": "5.30.2",
+    "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.1",
+    "sinon": "19.0.2",
     "strip-ansi": "7.1.0",
     "typescript": "5.6.2"
   },

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

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,25 @@ 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'
+  );
+});

package/test/stub/github.js

@@ -53,7 +53,8 @@ const interceptCreate = ({
       body,
       prerelease,
       draft,
-      generate_release_notes
+      generate_release_notes,
+      make_latest: 'true'
     })
     .reply(() => {
       const id = 1;
@@ -80,7 +81,15 @@ const interceptUpdate = ({
   body: { tag_name, name = '', body = null, prerelease = false, draft = false, generate_release_notes = 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: 'true'
+    })
     .reply(200, {
       id: 1,
       tag_name,

package/types/config.d.ts

@@ -132,6 +132,13 @@ 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 */
     skipChecks?: boolean;
 
@@ -170,7 +177,7 @@ export interface Config {
 
     /** @default null */
     certificateAuthorityFile?: any;
-    
+
     /** @default null */
     secure?: boolean;