release-it 17.8.1 → 17.9.0

package/README.md

@@ -328,34 +328,35 @@ 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]
+- [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]
 
 ## 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].
+v16, supporting Node.js 16. Use release-it v15 for environments running Node.js v14. Also see [CHANGELOG.md][78].
 
 ## 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 +421,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/lib/plugin/github/GitHub.js

@@ -215,7 +215,7 @@ class GitHub extends Release {
       preRelease = false,
       autoGenerate = false,
       makeLatest = true,
-      discussionCategoryName = false
+      discussionCategoryName = undefined
     } = this.options;
     const { tagName } = this.config.getContext();
     const { version, releaseNotes, isUpdate } = this.getContext();
@@ -236,7 +236,7 @@ class GitHub extends Release {
       draft,
       prerelease: isPreRelease || preRelease,
       generate_release_notes: autoGenerate,
-      discussion_category_name: discussionCategoryName.toString()
+      discussion_category_name: discussionCategoryName
     };
     return Object.assign(options, contextOptions);
   }

package/lib/plugin/gitlab/GitLab.js

@@ -189,10 +189,11 @@ class GitLab extends Release {
 
   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 releaseMilestones = this.getReleaseMilestones();
@@ -208,7 +209,9 @@ class GitLab extends Release {
     const options = {
       json: {
         name,
+        ref: branchName,
         tag_name: tagName,
+        tag_message: tagMessage,
         description
       }
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "17.8.1",
+  "version": "17.9.0",
   "description": "Generic CLI tool to automate versioning and package publishing-related tasks.",
   "keywords": [
     "build",
@@ -116,10 +116,10 @@
     "eslint-plugin-import-x": "4.3.1",
     "eslint-plugin-prettier": "5.2.1",
     "fs-monkey": "1.0.6",
-    "globals": "15.10.0",
+    "globals": "15.11.0",
     "installed-check": "9.3.0",
-    "knip": "5.31.0",
-    "memfs": "4.12.0",
+    "knip": "5.33.3",
+    "memfs": "4.14.0",
     "mock-stdio": "1.0.3",
     "nock": "14.0.0-beta.8",
     "prettier": "3.3.3",
@@ -127,7 +127,7 @@
     "remark-preset-webpro": "1.1.1",
     "sinon": "19.0.2",
     "strip-ansi": "7.1.0",
-    "typescript": "5.6.2"
+    "typescript": "5.6.3"
   },
   "overrides": {
     "pac-resolver": "7.0.1",

package/test/gitlab.js

@@ -2,6 +2,7 @@ import fs from 'node:fs';
 import test from 'ava';
 import sinon from 'sinon';
 import nock from 'nock';
+import Git from '../lib/plugin/git/Git.js';
 import GitLab from '../lib/plugin/gitlab/GitLab.js';
 import { factory, runTasks } from './util/index.js';
 import {
@@ -63,6 +64,9 @@ test.serial('should upload assets and release', async t => {
   const gitlab = factory(GitLab, { options });
   sinon.stub(gitlab, 'getLatestVersion').resolves('2.0.0');
 
+  const git = factory(Git);
+  const ref = (await git.getBranchName()) ?? 'HEAD';
+
   interceptUser();
   interceptCollaborator();
   interceptMilestones({
@@ -89,7 +93,9 @@ test.serial('should upload assets and release', async t => {
   interceptPublish({
     body: {
       name: 'Release 2.0.1',
+      ref,
       tag_name: '2.0.1',
+      tag_message: 'Release 2.0.1',
       description: 'Custom notes',
       assets: {
         links: [

package/test/stub/github.js

@@ -52,7 +52,7 @@ const interceptCreate = ({
     draft = false,
     generate_release_notes = false,
     make_latest = 'true',
-    discussion_category_name = 'false'
+    discussion_category_name = undefined
   }
 } = {}) => {
   nock(api)
@@ -97,7 +97,7 @@ const interceptUpdate = ({
     draft = false,
     generate_release_notes = false,
     make_latest = 'true',
-    discussion_category_name = 'false'
+    discussion_category_name = undefined
   }
 } = {}) => {
   nock(api)

package/test/tasks.interactive.js

@@ -8,10 +8,12 @@ import Spinner from '../lib/spinner.js';
 import Prompt from '../lib/prompt.js';
 import Config from '../lib/config.js';
 import runTasks from '../lib/index.js';
+import Git from '../lib/plugin/git/Git.js';
 import { mkTmpDir, gitAdd } from './util/helpers.js';
 import ShellStub from './stub/shell.js';
 import { interceptPublish as interceptGitLabPublish } from './stub/gitlab.js';
 import { interceptCreate as interceptGitHubCreate } from './stub/github.js';
+import { factory } from './util/index.js';
 
 const noop = Promise.resolve();
 
@@ -160,6 +162,9 @@ test.serial('should run "after:*:release" plugin hooks', async t => {
   sh.exec('git tag 1.0.0');
   const sha = gitAdd('line', 'file', 'More file');
 
+  const git = factory(Git);
+  const ref = (await git.getBranchName()) ?? 'HEAD';
+
   interceptGitHubCreate({
     owner,
     project,
@@ -171,7 +176,9 @@ test.serial('should run "after:*:release" plugin hooks', async t => {
     project,
     body: {
       name: 'Release 1.1.0',
+      ref,
       tag_name: '1.1.0',
+      tag_message: 'Release 1.1.0',
       description: `* More file (${sha})`
     }
   });

package/test/tasks.js

@@ -8,6 +8,7 @@ import Log from '../lib/log.js';
 import Spinner from '../lib/spinner.js';
 import Config from '../lib/config.js';
 import runTasks from '../lib/index.js';
+import Git from '../lib/plugin/git/Git.js';
 import { mkTmpDir, gitAdd, getArgs } from './util/helpers.js';
 import ShellStub from './stub/shell.js';
 import {
@@ -22,6 +23,7 @@ import {
   interceptCreate as interceptGitHubCreate,
   interceptAsset as interceptGitHubAsset
 } from './stub/github.js';
+import { factory } from './util/index.js';
 
 const rootDir = new URL('..', import.meta.url);
 
@@ -247,6 +249,8 @@ test.serial('should release all the things (pre-release, github, gitlab)', async
   sh.exec('git tag v1.0.0');
   const sha = gitAdd('line', 'file', 'More file');
   sh.exec('git push --follow-tags');
+  const git = factory(Git);
+  const ref = (await git.getBranchName()) ?? 'HEAD';
 
   interceptGitHubAuthentication();
   interceptGitHubCollaborator({ owner, project });
@@ -270,7 +274,9 @@ test.serial('should release all the things (pre-release, github, gitlab)', async
     project,
     body: {
       name: 'Release 1.1.0-alpha.0',
+      ref,
       tag_name: 'v1.1.0-alpha.0',
+      tag_message: `${owner} ${owner}/${project} ${project}`,
       description: `Notes for ${pkgName}: ${sha}`,
       assets: {
         links: [
@@ -333,7 +339,7 @@ test.serial('should release all the things (pre-release, github, gitlab)', async
   t.true(log.obtrusive.firstCall.args[0].endsWith(`release ${pkgName} (1.0.0...1.1.0-alpha.0)`));
   t.true(log.log.firstCall.args[0].endsWith(`https://www.npmjs.com/package/${pkgName}`));
   t.true(log.log.secondCall.args[0].endsWith(`https://github.com/${owner}/${project}/releases/tag/v1.1.0-alpha.0`));
-  t.true(log.log.args[3][0].endsWith(`${project}/-/releases`));
+  t.true(log.log.thirdCall.args[0].endsWith(`${project}/-/releases`));
   t.regex(log.log.lastCall.args[0], /Done \(in [0-9]+s\.\)/);
 
   exec.restore();
@@ -365,7 +371,7 @@ test.serial('should publish pre-release without pre-id with different npm.tag',
   t.is(stdout.trim(), 'v2.0.0-0');
   t.true(log.obtrusive.firstCall.args[0].endsWith(`release ${pkgName} (1.0.0...2.0.0-0)`));
   t.true(log.log.firstCall.args[0].endsWith(`https://www.npmjs.com/package/${pkgName}`));
-  t.regex(log.log.args[1][0], /Done \(in [0-9]+s\.\)/);
+  t.regex(log.log.lastCall.args[0], /Done \(in [0-9]+s\.\)/);
 
   exec.restore();
 });
@@ -385,7 +391,7 @@ test.serial('should handle private package correctly, bump lockfile', async t =>
   t.deepEqual(npmArgs, ['npm version 1.0.1 --no-git-tag-version']);
   t.true(log.obtrusive.firstCall.args[0].endsWith(`release ${pkgName} (1.0.0...1.0.1)`));
   t.is(log.warn.length, 0);
-  t.regex(log.log.args[0][0], /Done \(in [0-9]+s\.\)/);
+  t.regex(log.log.firstCall.args[0], /Done \(in [0-9]+s\.\)/);
 
   exec.restore();
 });