Chore/update next

.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release
+"on":
+  push:
+    branches:
+      - master
+      - next
+      - beta
+      - "*.x"
+permissions:
+  contents: read # for checkout
+jobs:
+  release:
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for npm provenance
+    name: release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        with:
+          cache: npm
+          node-version: lts/*
+      - run: npm ci
+      - run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.SEMANTIC_RELEASE_BOT_NPM_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,47 @@
+name: Test
+"on":
+  push:
+    branches:
+      - master
+      - renovate/**
+  pull_request:
+    types:
+      - opened
+      - synchronize
+jobs:
+  test_matrix:
+    strategy:
+      matrix:
+        node-version:
+          - 20.8.1 # minimum supported Node version
+          - 20
+          - 21
+          - 22
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+    runs-on: "${{ matrix.os }}"
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - name: "Use Node.js ${{ matrix.node-version }}"
+        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        with:
+          node-version: "${{ matrix.node-version }}"
+          cache: npm
+      - run: npm ci
+      - name: Ensure dependencies are compatible with the version of node
+        run: npx ls-engines
+      - run: npm run test
+  test:
+    runs-on: ubuntu-latest
+    needs: test_matrix
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - name: "Use Node.js ${{ matrix.node-version }}"
+        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        with:
+          node-version: "${{ matrix.node-version }}"
+          cache: npm
+      - run: npm ci
+      - run: npm run lint

.gitignore

@@ -126,6 +126,3 @@ $RECYCLE.BIN/
 *.lnk
 
 # End of https://www.gitignore.io/api/macos,windows,linux,node
-
-package-lock.json
-yarn.lock

index.js

@@ -1,16 +1,18 @@
 /* eslint require-atomic-updates: off */
 
-const verifyGitLab = require('./lib/verify');
-const publishGitLab = require('./lib/publish');
+import verifyGitLab from "./lib/verify.js";
+import publishGitLab from "./lib/publish.js";
+import successGitLab from "./lib/success.js";
+import failGitLab from "./lib/fail.js";
 
 let verified;
 
-async function verifyConditions(pluginConfig, context) {
+export async function verifyConditions(pluginConfig, context) {
   await verifyGitLab(pluginConfig, context);
   verified = true;
 }
 
-async function publish(pluginConfig, context) {
+export async function publish(pluginConfig, context) {
   if (!verified) {
     await verifyGitLab(pluginConfig, context);
     verified = true;
@@ -19,4 +21,20 @@ async function publish(pluginConfig, context) {
   return publishGitLab(pluginConfig, context);
 }
 
-module.exports = {verifyConditions, publish};
+export async function success(pluginConfig, context) {
+  if (!verified) {
+    await verifyGitLab(pluginConfig, context);
+    verified = true;
+  }
+
+  return successGitLab(pluginConfig, context);
+}
+
+export async function fail(pluginConfig, context) {
+  if (!verified) {
+    await verifyGitLab(pluginConfig, context);
+    verified = true;
+  }
+
+  return failGitLab(pluginConfig, context);
+}

lib/definitions/constants.js

@@ -0,0 +1,3 @@
+export const HOME_URL = 'https://github.com/semantic-release/semantic-release';
+
+export const RELEASE_NAME = 'GitLab release';

lib/definitions/errors.js

@@ -1,34 +1,60 @@
-const {inspect} = require('util');
-const pkg = require('../../package.json');
+import {inspect} from 'util';
+import { createRequire } from "node:module";
+const require = createRequire(import.meta.url);
 
+const pkg = require("../../package.json");
 const [homepage] = pkg.homepage.split('#');
-const linkify = file => `${homepage}/blob/master/${file}`;
-const stringify = obj => inspect(obj, {breakLength: Infinity, depth: 2, maxArrayLength: 5});
+const linkify = (file) => `${homepage}/blob/master/${file}`;
+const stringify = (object) => inspect(object, {breakLength: Number.POSITIVE_INFINITY, depth: 2, maxArrayLength: 5});
 
-module.exports = {
+export default {
   EINVALIDASSETS: ({assets}) => ({
     message: 'Invalid `assets` option.',
     details: `The [assets option](${linkify(
       'README.md#assets'
     )}) must be an \`Array\` of \`Strings\` or \`Objects\` with a \`path\` property.
 Your configuration for the \`assets\` option is \`${stringify(assets)}\`.`,
   }),
+  EINVALIDFAILTITLE: ({failTitle}) => ({
+    message: 'Invalid `failTitle` option.',
+    details: `The [failTitle option](${linkify('README.md#failtitle')}) if defined, must be a non empty \`String\`.
+
+Your configuration for the \`failTitle\` option is \`${stringify(failTitle)}\`.`,
+  }),
+  EINVALIDFAILCOMMENT: ({failComment}) => ({
+    message: 'Invalid `failComment` option.',
+    details: `The [failComment option](${linkify('README.md#failcomment')}) if defined, must be a non empty \`String\`.
+
+Your configuration for the \`failComment\` option is \`${stringify(failComment)}\`.`,
+  }),
+  EINVALIDLABELS: ({labels}) => ({
+    message: 'Invalid `labels` option.',
+    details: `The [labels option](${linkify('README.md#labels')}) if defined, must be a non empty \`String\`.
+
+Your configuration for the \`labels\` option is \`${stringify(labels)}\`.`,
+  }),
+  EINVALIDASSIGNEE: ({assignee}) => ({
+    message: 'Invalid `assignee` option.',
+    details: `The [assignee option](${linkify('README.md#assignee')}) if defined, must be a non empty \`String\`.
+
+    Your configuration for the \`assignee\` option is \`${stringify(assignee)}\`.`,
+  }),
   EINVALIDGITLABURL: () => ({
     message: 'The git repository URL is not a valid GitLab URL.',
-    details: `The **semantic-release** \`repositoryUrl\` option must a valid GitLab URL with the format \`<GitLab_URL>/<repoId>.git\`.
+    details: `The **semantic-release** \`repositoryUrl\` option must a valid GitLab URL with the format \`<GitLab_URL>/<projectPath>.git\`.
 
 By default the \`repositoryUrl\` option is retrieved from the \`repository\` property of your \`package.json\` or the [git origin url](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) of the repository cloned by your CI environment.`,
   }),
-  EINVALIDGLTOKEN: ({repoId}) => ({
+  EINVALIDGLTOKEN: ({projectPath}) => ({
     message: 'Invalid GitLab token.',
     details: `The [GitLab token](${linkify(
       'README.md#gitlab-authentication'
-    )}) configured in the \`GL_TOKEN\` or \`GITLAB_TOKEN\` environment variable must be a valid [personal access token](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html) allowing to push to the repository ${repoId}.
+    )}) configured in the \`GL_TOKEN\` or \`GITLAB_TOKEN\` environment variable must be a valid [personal access token](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html) allowing to push to the repository ${projectPath}.
 
 Please make sure to set the \`GL_TOKEN\` or \`GITLAB_TOKEN\` environment variable in your CI with the exact value of the GitLab personal token.`,
   }),
-  EMISSINGREPO: ({repoId}) => ({
-    message: `The repository ${repoId} doesn't exist.`,
+  EMISSINGREPO: ({projectPath}) => ({
+    message: `The repository ${projectPath} doesn't exist.`,
     details: `The **semantic-release** \`repositoryUrl\` option must refer to your GitLab repository. The repository must be accessible with the [GitLab API](https://docs.gitlab.com/ce/api/README.html).
 
 By default the \`repositoryUrl\` option is retrieved from the \`repository\` property of your \`package.json\` or the [git origin url](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) of the repository cloned by your CI environment.
@@ -37,20 +63,28 @@ If you are using [GitLab Enterprise Edition](https://about.gitlab.com/gitlab-ee)
       'README.md#options'
     )}).`,
   }),
-  EGLNOPERMISSION: ({repoId}) => ({
-    message: `The GitLab token doesn't allow to push on the repository ${repoId}.`,
+  EGLNOPUSHPERMISSION: ({projectPath}) => ({
+    message: `The GitLab token doesn't allow to push on the repository ${projectPath}.`,
+    details: `The user associated with the [GitLab token](${linkify(
+      'README.md#gitlab-authentication'
+    )}) configured in the \`GL_TOKEN\` or \`GITLAB_TOKEN\` environment variable must allows to push to the repository ${projectPath}.
+
+Please make sure the GitLab user associated with the token has the [permission to push](https://docs.gitlab.com/ee/user/permissions.html#project-members-permissions) to the repository ${projectPath}.`,
+  }),
+  EGLNOPULLPERMISSION: ({projectPath}) => ({
+    message: `The GitLab token doesn't allow to pull from the repository ${projectPath}.`,
     details: `The user associated with the [GitLab token](${linkify(
       'README.md#gitlab-authentication'
-    )}) configured in the \`GL_TOKEN\` or \`GITLAB_TOKEN\` environment variable must allows to push to the repository ${repoId}.
+    )}) configured in the \`GL_TOKEN\` or \`GITLAB_TOKEN\` environment variable must allow pull from the repository ${projectPath}.
 
-Please make sure the GitLab user associated with the token has the [permission to push](https://docs.gitlab.com/ee/user/permissions.html#project-members-permissions) to the repository ${repoId}.`,
+Please make sure the GitLab user associated with the token has the [permission to push](https://docs.gitlab.com/ee/user/permissions.html#project-members-permissions) to the repository ${projectPath}.`,
   }),
   ENOGLTOKEN: ({repositoryUrl}) => ({
     message: 'No GitLab token specified.',
-    details: `A [GitLab personnal access token](${linkify(
+    details: `A [GitLab personal access token](${linkify(
       'README.md#gitlab-authentication'
     )}) must be created and set in the \`GL_TOKEN\` or \`GITLAB_TOKEN\` environment variable on your CI environment.
 
-Please make sure to create a [GitLab personnal access token](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html) and to set it in the \`GL_TOKEN\` or \`GITLAB_TOKEN\` environment variable on your CI environment. The token must allow to push to the repository ${repositoryUrl}.`,
+Please make sure to create a [GitLab personal access token](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html) and to set it in the \`GL_TOKEN\` or \`GITLAB_TOKEN\` environment variable on your CI environment. The token must allow to push to the repository ${repositoryUrl}.`,
   }),
 };

lib/fail.js

@@ -0,0 +1,86 @@
+import { template } from "lodash-es";
+import urlJoin from "url-join";
+import got from "got";
+import _debug from "debug";
+const debug = _debug("semantic-release:gitlab");
+import resolveConfig from "./resolve-config.js";
+import getFailComment from "./get-fail-comment.js";
+import getProjectContext from "./get-project-context.js";
+
+export default async (pluginConfig, context) => {
+  const {
+    options: { repositoryUrl },
+    branch,
+    errors,
+    logger,
+  } = context;
+  const {
+    gitlabToken,
+    gitlabUrl,
+    gitlabApiUrl,
+    failComment,
+    failTitle,
+    failCommentCondition,
+    labels,
+    assignee,
+    retryLimit,
+  } = resolveConfig(pluginConfig, context);
+  const { encodedProjectPath, projectApiUrl } = getProjectContext(context, gitlabUrl, gitlabApiUrl, repositoryUrl);
+
+  const apiOptions = {
+    headers: { "PRIVATE-TOKEN": gitlabToken },
+    retry: { limit: retryLimit },
+  };
+
+  if (failComment === false || failTitle === false) {
+    logger.log("Skip issue creation.");
+    logger.error(`Failure reporting should be disabled via 'failCommentCondition'.
+Using 'false' for 'failComment' or 'failTitle' is deprecated and will be removed in a future major version.`);
+  } else if (failCommentCondition === false) {
+    logger.log("Skip issue creation.");
+  } else {
+    const encodedFailTitle = encodeURIComponent(failTitle);
+    const description = failComment ? template(failComment)({ branch, errors }) : getFailComment(branch, errors);
+
+    const issuesEndpoint = urlJoin(projectApiUrl, `issues`);
+    const openFailTitleIssueEndpoint = urlJoin(issuesEndpoint, `?state=opened&search=${encodedFailTitle}`);
+
+    const openFailTitleIssues = await got(openFailTitleIssueEndpoint, { ...apiOptions }).json();
+    const existingIssue = openFailTitleIssues.find((openFailTitleIssue) => openFailTitleIssue.title === failTitle);
+
+    const canCommentOnOrCreateIssue = failCommentCondition
+      ? template(failCommentCondition)({ ...context, issue: existingIssue })
+      : true;
+    if (canCommentOnOrCreateIssue) {
+      if (existingIssue) {
+        debug("comment on issue: %O", existingIssue);
+
+        const issueNotesEndpoint = urlJoin(
+          gitlabApiUrl,
+          `/projects/${existingIssue.project_id}/issues/${existingIssue.iid}/notes`
+        );
+        await got.post(issueNotesEndpoint, {
+          ...apiOptions,
+          json: { body: description },
+        });
+
+        const { id, web_url } = existingIssue;
+        logger.log("Commented on issue #%d: %s.", id, web_url);
+      } else {
+        const newIssue = { id: encodedProjectPath, description, labels, title: failTitle, assignee_id: assignee };
+        debug("create issue: %O", newIssue);
+
+        /* eslint camelcase: off */
+        const { id, web_url } = await got
+          .post(issuesEndpoint, {
+            ...apiOptions,
+            json: newIssue,
+          })
+          .json();
+        logger.log("Created issue #%d: %s.", id, web_url);
+      }
+    } else {
+      logger.log("Skip commenting on or creating an issue.");
+    }
+  }
+};

lib/get-error.js

@@ -1,7 +1,7 @@
-const SemanticReleaseError = require('@semantic-release/error');
-const ERROR_DEFINITIONS = require('./definitions/errors');
+import SemanticReleaseError from "@semantic-release/error";
+import ERROR_DEFINITIONS from "./definitions/errors.js";
 
-module.exports = (code, ctx = {}) => {
-  const {message, details} = ERROR_DEFINITIONS[code](ctx);
+export default (code, ctx = {}) => {
+  const { message, details } = ERROR_DEFINITIONS[code](ctx);
   return new SemanticReleaseError(message, code, details);
 };