release-it 17.9.0 → 17.11.0

package/README.md

@@ -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.
 

package/config/release-it.json

@@ -66,6 +66,8 @@
     "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/gitlab/GitLab.js

@@ -167,24 +167,40 @@ 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() {
@@ -195,7 +211,7 @@ class GitLab extends Release {
     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 });
@@ -227,10 +243,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);
@@ -240,25 +257,47 @@ 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();
-    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;
+    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": "17.9.0",
+  "version": "17.11.0",
   "description": "Generic CLI tool to automate versioning and package publishing-related tasks.",
   "keywords": [
     "build",
@@ -81,8 +81,8 @@
     "@iarna/toml": "2.2.5",
     "@octokit/rest": "20.1.1",
     "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": "8.0.0",
     "git-url-parse": "14.0.0",
@@ -93,41 +93,41 @@
     "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": "5.1.0",
-    "proxy-agent": "6.4.0",
+    "proxy-agent": "6.5.0",
     "semver": "7.6.3",
     "shelljs": "0.8.5",
     "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.2.0",
-    "@eslint/eslintrc": "3.1.0",
-    "@eslint/js": "9.12.0",
+    "@eslint/compat": "1.2.4",
+    "@eslint/eslintrc": "3.2.0",
+    "@eslint/js": "9.17.0",
     "@octokit/request-error": "5.1.0",
     "@types/node": "20.14.10",
-    "ava": "6.1.3",
-    "eslint": "9.12.0",
+    "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.3.1",
+    "eslint-plugin-import-x": "4.6.1",
     "eslint-plugin-prettier": "5.2.1",
     "fs-monkey": "1.0.6",
-    "globals": "15.11.0",
+    "globals": "15.14.0",
     "installed-check": "9.3.0",
-    "knip": "5.33.3",
-    "memfs": "4.14.0",
+    "knip": "5.41.1",
+    "memfs": "4.15.1",
     "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.1",
     "sinon": "19.0.2",
     "strip-ansi": "7.1.0",
-    "typescript": "5.6.3"
+    "typescript": "5.7.2"
   },
   "overrides": {
     "pac-resolver": "7.0.1",

package/schema/gitlab.json

@@ -56,6 +56,14 @@
       "type": "boolean",
       "default": false
     },
+    "useGenericPackageRepositoryForAssets": {
+      "type": "boolean",
+      "default": false
+    },
+    "genericPackageRepositoryName": {
+       "type": "string",
+       "default": "release-it"
+    },
     "origin": {
       "type": "string",
       "default": null

package/test/gitlab.js

@@ -10,6 +10,7 @@ import {
   interceptCollaborator,
   interceptPublish,
   interceptAsset,
+  interceptAssetGeneric,
   interceptMilestones
 } from './stub/gitlab.js';
 
@@ -114,7 +115,7 @@ test.serial('should upload assets and release', async t => {
   t.is(gitlab.assets[0].url, `${pushRepo}/uploads/7e8bec1fe27cc46a4bc6a91b9e82a07c/file-v2.0.1.txt`);
   const { isReleased, releaseUrl } = gitlab.getContext();
   t.true(isReleased);
-  t.is(releaseUrl, `${pushRepo}/-/releases`);
+  t.is(releaseUrl, `${pushRepo}/-/releases/2.0.1`);
 });
 
 test.serial('should upload assets with ID-based URLs too', async t => {
@@ -142,6 +143,32 @@ test.serial('should upload assets with ID-based URLs too', async t => {
   t.is(gitlab.assets[0].url, `${host}/-/project/1234/uploads/7e8bec1fe27cc46a4bc6a91b9e82a07c/file-v2.0.1.txt`);
 });
 
+test.serial('should upload assets to generic repo', 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',
+      useGenericPackageRepositoryForAssets: true,
+      genericPackageRepositoryName: 'release-it'
+    }
+  };
+  const gitlab = factory(GitLab, { options });
+  sinon.stub(gitlab, 'getLatestVersion').resolves('2.0.0');
+
+  interceptUser();
+  interceptCollaborator();
+  interceptAssetGeneric();
+  interceptPublish();
+
+  await runTasks(gitlab);
+
+  t.is(gitlab.assets[0].url, `${host}/api/v4/projects/user%2Frepo/packages/generic/release-it/2.0.1/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 = {
@@ -211,7 +238,7 @@ test.serial('should release to sub-grouped repo', async t => {
 
   const { isReleased, releaseUrl } = gitlab.getContext();
   t.true(isReleased);
-  t.is(releaseUrl, 'https://gitlab.com/group/sub-group/repo/-/releases');
+  t.regex(releaseUrl, /https:\/\/gitlab.com\/group\/sub-group\/repo\/-\/releases\//);
 });
 
 test.serial('should throw for unauthenticated user', async t => {
@@ -265,7 +292,7 @@ test('should not make requests in dry run', async t => {
   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`);
+  t.is(releaseUrl, `${pushRepo}/-/releases/1.0.1`);
 });
 
 test('should skip checks', async t => {

package/test/stub/gitlab.js

@@ -12,7 +12,13 @@ export let interceptCollaborator = (
     .reply(200, { id: userId, username: owner, access_level: 30 });
 
 export let interceptPublish = ({ host = 'https://gitlab.com', owner = 'user', project = 'repo', body } = {}, options) =>
-  nock(host, options).post(`/api/v4/projects/${owner}%2F${project}/releases`, body).reply(200, {});
+  nock(host, options)
+    .post(`/api/v4/projects/${owner}%2F${project}/releases`, body)
+    .reply(200, {
+      _links: {
+        self: `https://gitlab.com/${owner}/${project}/-/releases/${body?.tag_name ?? '1.0.0'}`
+      }
+    });
 
 export let interceptMilestones = (
   { host = 'https://gitlab.com', owner = 'user', project = 'repo', query = {}, milestones = [] } = {},
@@ -34,12 +40,24 @@ export let interceptAsset = ({ host = 'https://gitlab.com', owner = 'user', proj
   nock(host)
     .post(`/api/v4/projects/${owner}%2F${project}/uploads`)
     .query(true)
-    .reply(200, function (_, requestBody) {
+    .reply(200, (_, requestBody) => {
       const [, name] = requestBody.match(/filename="([^"]+)/);
       return {
         alt: name,
         url: `/uploads/7e8bec1fe27cc46a4bc6a91b9e82a07c/${name}`,
         full_path: `/-/project/1234/uploads/7e8bec1fe27cc46a4bc6a91b9e82a07c/${name}`,
-        markdown: `[${name}](/uploads/7e8bec1fe27cc46a4bc6a91b9e82a07c/${name})`
+        markdown: `[${name}](/uploads/7e8bec1fe27cc46a4bc6a91b9e82a07c/${name})`,
+        _links: {
+          self: `https://gitlab.com/${owner}/${project}/-/releases/${name}`
+        }
+      };
+    });
+
+export let interceptAssetGeneric = ({ host = 'https://gitlab.com', owner = 'user', project = 'repo' } = {}) =>
+  nock(host)
+    .put(`/api/v4/projects/${owner}%2F${project}/packages/generic/release-it/2.0.1/file-v2.0.1.txt`)
+    .reply(200, () => {
+      return {
+        message: '201 Created'
       };
     });

package/test/tasks.js

@@ -339,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.thirdCall.args[0].endsWith(`${project}/-/releases`));
+  t.true(log.log.thirdCall.args[0].endsWith(`${project}/-/releases/v1.1.0-alpha.0`));
   t.regex(log.log.lastCall.args[0], /Done \(in [0-9]+s\.\)/);
 
   exec.restore();

package/types/config.d.ts

@@ -190,6 +190,12 @@ export interface Config {
     /** @default false */
     useIdsForUrls?: boolean;
 
+    /** @default false */
+    useGenericPackageRepositoryForAssets?: boolean;
+
+    /** @default "release-it" */
+    genericPackageRepositoryName?: string;
+
     /** @default null */
     origin?: any;