mtdev2 · pull · Sep 12, 2024 · Sep 12, 2024 · Sep 12, 2024 · Sep 12, 2024
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,32 @@
+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@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
+        with:
+          cache: npm
+          node-version: lts/*
+      - run: npm clean-install
+      - run: npm install --global corepack@latest
+      - run: corepack npm audit signatures
+      - run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.SEMANTIC_RELEASE_BOT_NPM_TOKEN }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,73 @@
+name: Test
+"on":
+  push:
+    branches:
+      - master
+      - renovate/**
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
+env:
+  FORCE_COLOR: 1
+  NPM_CONFIG_COLOR: always
+
+jobs:
+  # verify against ranges defined as supported in engines.node
+  test_matrix:
+    strategy:
+      matrix:
+        node-version:
+          - 22.14.0
+          - 24.10.0
+          - 24
+        os:
+          - ubuntu-latest
+    runs-on: "${{ matrix.os }}"
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - name: "Use Node.js ${{ matrix.node-version }}"
+        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
+        with:
+          node-version: "${{ matrix.node-version }}"
+          cache: npm
+      - run: npm clean-install
+      - run: npm install --global corepack@latest
+      - run: corepack npm audit signatures
+      - run: npm test
+
+  # verify against the node version defined for development in the .nvmrc
+  test_dev:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - run: git config --global user.name github-actions
+      - run: git config --global user.email github-actions@github.com
+      - name: Use Node.js from .nvmrc
+        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
+        with:
+          node-version-file: .nvmrc
+          cache: npm
+      - run: npm clean-install
+      - run: npm install --global corepack@latest
+      - run: corepack npm audit signatures
+      - run: npm test
+
+  # separate job to set as required in branch protection,
+  # as the build names above change each time Node versions change
+  test:
+    runs-on: ubuntu-latest
+    needs:
+      - test_dev
+      - test_matrix
+    if: always()
+    steps:
+      - name: All matrix versions passed
+        if: ${{ !(contains(needs.*.result, 'failure')) }}
+        run: exit 0
+      - name: Some matrix version failed
+        if: ${{ contains(needs.*.result, 'failure') }}
+        run: exit 1
diff --git a/.gitignore b/.gitignore
@@ -125,7 +125,4 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-# End of https://www.gitignore.io/api/macos,windows,linux,node
-
-package-lock.json
-yarn.lock
+# End of https://www.gitignore.io/api/macos,windows,linux,node
diff --git a/.npmrc b/.npmrc
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+24
diff --git a/.travis.yml b/.travis.yml
diff --git a/.yarnrc b/.yarnrc
diff --git a/README.md b/README.md
diff --git a/index.js b/index.js
@@ -1,67 +1,105 @@
 /* eslint require-atomic-updates: off */
 
-const {defaultTo, castArray} = require('lodash');
-const verifyGitHub = require('./lib/verify');
-const addChannelGitHub = require('./lib/add-channel');
-const publishGitHub = require('./lib/publish');
-const successGitHub = require('./lib/success');
-const failGitHub = require('./lib/fail');
+import { defaultTo, castArray } from "lodash-es";
+
+import verifyGitHub from "./lib/verify.js";
+import addChannelGitHub from "./lib/add-channel.js";
+import publishGitHub from "./lib/publish.js";
+import successGitHub from "./lib/success.js";
+import failGitHub from "./lib/fail.js";
+import { SemanticReleaseOctokit } from "./lib/octokit.js";
 
 let verified;
 
-async function verifyConditions(pluginConfig, context) {
-  const {options} = context;
-  // If the GitHub publish plugin is used and has `assets`, `successComment`, `failComment`, `failTitle`, `labels` or `assignees` configured, validate it now in order to prevent any release if the configuration is wrong
+export async function verifyConditions(
+  pluginConfig,
+  context,
+  { Octokit = SemanticReleaseOctokit } = {},
+) {
+  const { options } = context;
+  // If the GitHub publish plugin is used and has `assets`, `successComment`, `failComment`, `failTitle`, `labels`, `discussionCategoryName` or `assignees` configured, validate it now in order to prevent any release if the configuration is wrong
   if (options.publish) {
     const publishPlugin =
-      castArray(options.publish).find(config => config.path && config.path === '@semantic-release/github') || {};
+      castArray(options.publish).find(
+        (config) => config.path && config.path === "@semantic-release/github",
+      ) || {};
 
     pluginConfig.assets = defaultTo(pluginConfig.assets, publishPlugin.assets);
-    pluginConfig.successComment = defaultTo(pluginConfig.successComment, publishPlugin.successComment);
-    pluginConfig.failComment = defaultTo(pluginConfig.failComment, publishPlugin.failComment);
-    pluginConfig.failTitle = defaultTo(pluginConfig.failTitle, publishPlugin.failTitle);
+    pluginConfig.successComment = defaultTo(
+      pluginConfig.successComment,
+      publishPlugin.successComment,
+    );
+    pluginConfig.failComment = defaultTo(
+      pluginConfig.failComment,
+      publishPlugin.failComment,
+    );
+    pluginConfig.failTitle = defaultTo(
+      pluginConfig.failTitle,
+      publishPlugin.failTitle,
+    );
     pluginConfig.labels = defaultTo(pluginConfig.labels, publishPlugin.labels);
-    pluginConfig.assignees = defaultTo(pluginConfig.assignees, publishPlugin.assignees);
+    pluginConfig.assignees = defaultTo(
+      pluginConfig.assignees,
+      publishPlugin.assignees,
+    );
+    pluginConfig.discussionCategoryName = defaultTo(
+      pluginConfig.discussionCategoryName,
+      publishPlugin.discussionCategoryName,
+    );
   }
 
-  await verifyGitHub(pluginConfig, context);
+  await verifyGitHub(pluginConfig, context, { Octokit });
   verified = true;
 }
 
-async function publish(pluginConfig, context) {
+export async function publish(
+  pluginConfig,
+  context,
+  { Octokit = SemanticReleaseOctokit } = {},
+) {
   if (!verified) {
-    await verifyGitHub(pluginConfig, context);
+    await verifyGitHub(pluginConfig, context, { Octokit });
     verified = true;
   }
 
-  return publishGitHub(pluginConfig, context);
+  return publishGitHub(pluginConfig, context, { Octokit });
 }
 
-async function addChannel(pluginConfig, context) {
+export async function addChannel(
+  pluginConfig,
+  context,
+  { Octokit = SemanticReleaseOctokit } = {},
+) {
   if (!verified) {
-    await verifyGitHub(pluginConfig, context);
+    await verifyGitHub(pluginConfig, context, { Octokit });
     verified = true;
   }
 
-  return addChannelGitHub(pluginConfig, context);
+  return addChannelGitHub(pluginConfig, context, { Octokit });
 }
 
-async function success(pluginConfig, context) {
+export async function success(
+  pluginConfig,
+  context,
+  { Octokit = SemanticReleaseOctokit } = {},
+) {
   if (!verified) {
-    await verifyGitHub(pluginConfig, context);
+    await verifyGitHub(pluginConfig, context, { Octokit });
     verified = true;
   }
 
-  await successGitHub(pluginConfig, context);
+  await successGitHub(pluginConfig, context, { Octokit });
 }
 
-async function fail(pluginConfig, context) {
+export async function fail(
+  pluginConfig,
+  context,
+  { Octokit = SemanticReleaseOctokit } = {},
+) {
   if (!verified) {
-    await verifyGitHub(pluginConfig, context);
+    await verifyGitHub(pluginConfig, context, { Octokit });
     verified = true;
   }
 
-  await failGitHub(pluginConfig, context);
+  await failGitHub(pluginConfig, context, { Octokit });
 }
-
-module.exports = {verifyConditions, addChannel, publish, success, fail};
diff --git a/lib/add-channel.js b/lib/add-channel.js
@@ -1,52 +1,80 @@
-const debug = require('debug')('semantic-release:github');
-const {RELEASE_NAME} = require('./definitions/constants');
-const parseGithubUrl = require('./parse-github-url');
-const resolveConfig = require('./resolve-config');
-const getClient = require('./get-client');
-const isPrerelease = require('./is-prerelease');
-
-module.exports = async (pluginConfig, context) => {
+import debugFactory from "debug";
+
+import { RELEASE_NAME } from "./definitions/constants.js";
+import parseGithubUrl from "./parse-github-url.js";
+import resolveConfig from "./resolve-config.js";
+import isPrerelease from "./is-prerelease.js";
+import { toOctokitOptions } from "./octokit.js";
+
+const debug = debugFactory("semantic-release:github");
+
+export default async function addChannel(pluginConfig, context, { Octokit }) {
   const {
-    options: {repositoryUrl},
+    options: { repositoryUrl },
     branch,
-    nextRelease: {name, gitTag, notes},
+    nextRelease: { name, gitTag, notes },
     logger,
   } = context;
-  const {githubToken, githubUrl, githubApiPathPrefix, proxy} = resolveConfig(pluginConfig, context);
-  const {owner, repo} = parseGithubUrl(repositoryUrl);
-  const github = getClient({githubToken, githubUrl, githubApiPathPrefix, proxy});
+  const { githubToken, githubUrl, githubApiPathPrefix, githubApiUrl, proxy } =
+    resolveConfig(pluginConfig, context);
+  const { owner, repo } = parseGithubUrl(repositoryUrl);
+  const octokit = new Octokit(
+    toOctokitOptions({
+      githubToken,
+      githubUrl,
+      githubApiPathPrefix,
+      githubApiUrl,
+      proxy,
+    }),
+  );
   let releaseId;
 
-  const release = {owner, repo, name, prerelease: isPrerelease(branch), tag_name: gitTag};
+  const release = {
+    owner,
+    repo,
+    name,
+    prerelease: isPrerelease(branch),
+    tag_name: gitTag,
+  };
 
-  debug('release object: %O', release);
+  debug("release object: %O", release);
 
   try {
     ({
-      data: {id: releaseId},
-    } = await github.repos.getReleaseByTag({owner, repo, tag: gitTag}));
+      data: { id: releaseId },
+    } = await octokit.request("GET /repos/{owner}/{repo}/releases/tags/{tag}", {
+      owner,
+      repo,
+      tag: gitTag,
+    }));
   } catch (error) {
     if (error.status === 404) {
-      logger.log('There is no release for tag %s, creating a new one', gitTag);
+      logger.log("There is no release for tag %s, creating a new one", gitTag);
 
       const {
-        data: {html_url: url},
-      } = await github.repos.createRelease({...release, body: notes});
+        data: { html_url: url },
+      } = await octokit.request("POST /repos/{owner}/{repo}/releases", {
+        ...release,
+        body: notes,
+      });
 
-      logger.log('Published GitHub release: %s', url);
-      return {url, name: RELEASE_NAME};
+      logger.log("Published GitHub release: %s", url);
+      return { url, name: RELEASE_NAME };
     }
 
     throw error;
   }
 
-  debug('release release_id: %o', releaseId);
+  debug("release release_id: %o", releaseId);
 
   const {
-    data: {html_url: url},
-  } = await github.repos.updateRelease({...release, release_id: releaseId});
+    data: { html_url: url },
+  } = await octokit.request(
+    "PATCH /repos/{owner}/{repo}/releases/{release_id}",
+    { ...release, release_id: releaseId },
+  );
 
-  logger.log('Updated GitHub release: %s', url);
+  logger.log("Updated GitHub release: %s", url);
 
-  return {url, name: RELEASE_NAME};
-};
+  return { url, name: RELEASE_NAME };
+}
diff --git a/lib/definitions/constants.js b/lib/definitions/constants.js
@@ -1,5 +1,5 @@
-const ISSUE_ID = '<!-- semantic-release:github -->';
+export const ISSUE_ID = "<!-- semantic-release:github -->";
 
-const RELEASE_NAME = 'GitHub release';
+export const RELEASE_NAME = "GitHub release";
 
-module.exports = {ISSUE_ID, RELEASE_NAME};
+export const RELEASE_FAIL_LABEL = "semantic-release";