Merge pull request #1017 from semantic-release/beta

Author: travi

.github/workflows/release.yml

@@ -5,6 +5,7 @@ name: Release
       - master
       - next
       - beta
+      - alpha
       - "*.x"
 permissions:
   contents: read

.github/workflows/test.yml

@@ -23,7 +23,7 @@ jobs:
         node-version:
           - 22.14.0
           - 22
-          - 24
+        #          - 24
         os:
           - ubuntu-latest
     runs-on: "${{ matrix.os }}"

README.md

@@ -38,41 +38,63 @@ The plugin can be configured in the [**semantic-release** configuration file](ht
 
 ### npm registry authentication
 
-The npm [token](https://docs.npmjs.com/about-access-tokens) authentication configuration is **required** and can be set via [environment variables](#environment-variables).
+### Official Registry
 
-Automation tokens are recommended since they can be used for an automated workflow, even when your account is configured to use the [`auth-and-writes` level of 2FA](https://docs.npmjs.com/about-two-factor-authentication#authorization-and-writes).
+When publishing to the [official registry](https://registry.npmjs.org/), it is recommended to publish with authentication intended for automation:
 
-### npm provenance
+- For improved security, and since access tokens have recently had their [maximum lifetimes restricted](https://github.blog/changelog/2025-09-29-strengthening-npm-security-important-changes-to-authentication-and-token-management/),
+  [trusted publishing](https://docs.npmjs.com/trusted-publishers) is recommended when publishing from a [supported CI provider](https://docs.npmjs.com/trusted-publishers#supported-cicd-providers)
+- [Granular access tokens](https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-granular-access-tokens-on-the-website) are recommended when publishing from a CI provider that is not supported by npm for trusted publishing, and can be set via [environment variables](#environment-variables).
+  Because these access tokens expire, rotation will need to be accounted for in this scenario.
 
-If you are publishing to the official registry and your pipeline is on a [provider that is supported by npm for provenance](https://docs.npmjs.com/generating-provenance-statements#provenance-limitations), npm can be configured to [publish with provenance](https://docs.npmjs.com/generating-provenance-statements).
+> [!NOTE]
+> When using trusted publishing, provenance attestations are automatically generated for your packages without requiring provenance to be explicitly enabled.
 
-Since semantic-release wraps the npm publish command, configuring provenance is not exposed directly.
-Instead, provenance can be configured through the [other configuration options exposed by npm](https://docs.npmjs.com/generating-provenance-statements#using-third-party-package-publishing-tools).
-Provenance applies specifically to publishing, so our recommendation is to configure under `publishConfig` within the `package.json`.
+#### Trusted publishing from GitHub Actions
 
-#### npm provenance on GitHub Actions
-
-For package provenance to be signed on the GitHub Actions CI the following permission is required
-to be enabled on the job:
+To leverage trusted publishing and publish with provenance from GitHub Actions, the `id-token: write` permission is required to be enabled on the job:
 
 ```yaml
 permissions:
-  id-token: write # to enable use of OIDC for npm provenance
+  id-token: write # to enable use of OIDC for trusted publishing and npm provenance
 ```
 
-It's worth noting that if you are using semantic-release to its fullest with a GitHub release, GitHub comments,
+It's also worth noting that if you are using semantic-release to its fullest with a GitHub release, GitHub comments,
 and other features, then [more permissions are required](https://github.com/semantic-release/github#github-authentication) to be enabled on this job:
 
 ```yaml
 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
+  id-token: write # to enable use of OIDC for trusted publishing and npm provenance
 ```
 
 Refer to the [GitHub Actions recipe for npm package provenance](https://semantic-release.gitbook.io/semantic-release/recipes/ci-configurations/github-actions#.github-workflows-release.yml-configuration-for-node-projects) for the full CI job's YAML code example.
 
+#### Trusted publishing for GitLab Pipelines
+
+To leverage trusted publishing and publish with provenance from GitLab Pipelines, `NPM_ID_TOKEN` needs to be added as an entry under `id_tokens` in the job definition with an audience of `npm:registry.npmjs.org`:
+
+```yaml
+id_tokens:
+  NPM_ID_TOKEN:
+    aud: "npm:registry.npmjs.org"
+```
+
+See the [npm documentation for more details about configuring pipeline details](https://docs.npmjs.com/trusted-publishers#gitlab-cicd-configuration)
+
+#### Unsupported CI providers
+
+Token authentication is **required** and can be set via [environment variables](#environment-variables).
+[Granular access tokens](https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-granular-access-tokens-on-the-website) are recommended in this scenario, since trusted publishing is not available from all CI providers.
+Because these access tokens expire, rotation will need to be accounted for in your process.
+
+### Alternative Registries
+
+Token authentication is **required** and can be set via [environment variables](#environment-variables).
+See the documentation for your registry for details on how to create a token for automation.
+
 ### Environment variables
 
 | Variable    | Description                                                                                                                   |
@@ -97,13 +119,14 @@ The plugin uses the [`npm` CLI](https://github.com/npm/cli) which will read the
 
 The [`registry`](https://docs.npmjs.com/misc/registry) can be configured via the npm environment variable `NPM_CONFIG_REGISTRY` and will take precedence over the configuration in `.npmrc`.
 
-The [`registry`](https://docs.npmjs.com/misc/registry) and [`dist-tag`](https://docs.npmjs.com/cli/dist-tag) can be configured under `publishConfig` in the `package.json`:
+The [`registry`](https://docs.npmjs.com/misc/registry), [`dist-tag`](https://docs.npmjs.com/cli/dist-tag), and [`provenance`](https://docs.npmjs.com/generating-provenance-statements#using-third-party-package-publishing-tools) can be configured under `publishConfig` in the `package.json`:
 
 ```json
 {
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "tag": "latest"
+    "tag": "latest",
+    "provenance": true
   }
 }
 ```

index.js

@@ -30,7 +30,7 @@ export async function verifyConditions(pluginConfig, context) {
 
     // Verify the npm authentication only if `npmPublish` is not false and `pkg.private` is not `true`
     if (pluginConfig.npmPublish !== false && pkg.private !== true) {
-      await verifyNpmAuth(npmrc, pkg, context);
+      await verifyNpmAuth(npmrc, pkg, pluginConfig, context);
     }
   } catch (error) {
     errors.push(...error.errors);
@@ -50,7 +50,7 @@ export async function prepare(pluginConfig, context) {
     // Reload package.json in case a previous external step updated it
     const pkg = await getPkg(pluginConfig, context);
     if (!verified && pluginConfig.npmPublish !== false && pkg.private !== true) {
-      await verifyNpmAuth(npmrc, pkg, context);
+      await verifyNpmAuth(npmrc, pkg, pluginConfig, context);
     }
   } catch (error) {
     errors.push(...error.errors);
@@ -72,7 +72,7 @@ export async function publish(pluginConfig, context) {
     // Reload package.json in case a previous external step updated it
     pkg = await getPkg(pluginConfig, context);
     if (!verified && pluginConfig.npmPublish !== false && pkg.private !== true) {
-      await verifyNpmAuth(npmrc, pkg, context);
+      await verifyNpmAuth(npmrc, pkg, pluginConfig, context);
     }
   } catch (error) {
     errors.push(...error.errors);
@@ -97,7 +97,7 @@ export async function addChannel(pluginConfig, context) {
     // Reload package.json in case a previous external step updated it
     pkg = await getPkg(pluginConfig, context);
     if (!verified && pluginConfig.npmPublish !== false && pkg.private !== true) {
-      await verifyNpmAuth(npmrc, pkg, context);
+      await verifyNpmAuth(npmrc, pkg, pluginConfig, context);
     }
   } catch (error) {
     errors.push(...error.errors);

lib/definitions/constants.js

@@ -0,0 +1,4 @@
+export const OFFICIAL_REGISTRY = "https://registry.npmjs.org/";
+
+export const GITHUB_ACTIONS_PROVIDER_NAME = "GitHub Actions";
+export const GITLAB_PIPELINES_PROVIDER_NAME = "GitLab CI/CD";

lib/definitions/errors.js

@@ -37,11 +37,22 @@ Your configuration for the \`pkgRoot\` option is \`${pkgRoot}\`.`,
 export function ENONPMTOKEN({ registry }) {
   return {
     message: "No npm token specified.",
-    details: `An [npm token](${linkify(
+    details: `When not publishing through [trusted publishing](https://docs.npmjs.com/trusted-publishers), an [npm token](${linkify(
       "README.md#npm-registry-authentication"
     )}) must be created and set in the \`NPM_TOKEN\` environment variable on your CI environment.
 
-Please make sure to create an [npm token](https://docs.npmjs.com/getting-started/working_with_tokens#how-to-create-new-tokens) and to set it in the \`NPM_TOKEN\` environment variable on your CI environment. The token must allow to publish to the registry \`${registry}\`.`,
+Please make sure to create an [npm token](https://docs.npmjs.com/getting-started/working_with_tokens#how-to-create-new-tokens) and set it in the \`NPM_TOKEN\` environment variable on your CI environment. The token must allow publishing to the registry \`${registry}\`.`,
+  };
+}
+
+export function EINVALIDNPMAUTH({ registry }) {
+  return {
+    message: "Invalid npm authentication.",
+    details: `The [authentication required to publish](${linkify(
+      "README.md#npm-registry-authentication"
+    )}) configured in the \`NPM_TOKEN\` environment variable must be a valid [token](https://docs.npmjs.com/getting-started/working_with_tokens) allowed to publish to the registry \`${registry}\`.
+
+Please make sure to set the \`NPM_TOKEN\` environment variable in your CI with the exact value of the npm token.`,
   };
 }
 
@@ -52,10 +63,7 @@ export function EINVALIDNPMTOKEN({ registry }) {
       "README.md#npm-registry-authentication"
     )}) configured in the \`NPM_TOKEN\` environment variable must be a valid [token](https://docs.npmjs.com/getting-started/working_with_tokens) allowing to publish to the registry \`${registry}\`.
 
-If you are using Two Factor Authentication for your account, set its level to ["Authorization only"](https://docs.npmjs.com/getting-started/using-two-factor-authentication#levels-of-authentication) in your account settings. **semantic-release** cannot publish with the default "
-Authorization and writes" level.
-
-Please make sure to set the \`NPM_TOKEN\` environment variable in your CI with the exact value of the npm token.`,
+Please verify your authentication configuration.`,
   };
 }
 

lib/get-registry.js

@@ -1,18 +1,15 @@
 import path from "path";
 import rc from "rc";
 import getRegistryUrl from "registry-auth-token/registry-url.js";
+import { OFFICIAL_REGISTRY } from "./definitions/constants.js";
 
 export default function ({ publishConfig: { registry } = {}, name }, { cwd, env }) {
   return (
     registry ||
     env.NPM_CONFIG_REGISTRY ||
     getRegistryUrl(
       name.split("/")[0],
-      rc(
-        "npm",
-        { registry: "https://registry.npmjs.org/" },
-        { config: env.NPM_CONFIG_USERCONFIG || path.resolve(cwd, ".npmrc") }
-      )
+      rc("npm", { registry: OFFICIAL_REGISTRY }, { config: env.NPM_CONFIG_USERCONFIG || path.resolve(cwd, ".npmrc") })
     )
   );
 }

lib/get-release-info.js

@@ -1,8 +1,9 @@
 import normalizeUrl from "normalize-url";
+import { OFFICIAL_REGISTRY } from "./definitions/constants.js";
 
 export default function (
   { name },
-  { env: { DEFAULT_NPM_REGISTRY = "https://registry.npmjs.org/" }, nextRelease: { version } },
+  { env: { DEFAULT_NPM_REGISTRY = OFFICIAL_REGISTRY }, nextRelease: { version } },
   distTag,
   registry
 ) {

lib/set-npmrc-auth.js

@@ -5,12 +5,13 @@ import getAuthToken from "registry-auth-token";
 import nerfDart from "nerf-dart";
 import AggregateError from "aggregate-error";
 import getError from "./get-error.js";
+import { OFFICIAL_REGISTRY } from "./definitions/constants.js";
 
 export default async function (npmrc, registry, { cwd, env: { NPM_TOKEN, NPM_CONFIG_USERCONFIG }, logger }) {
   logger.log("Verify authentication for registry %s", registry);
-  const { configs, ...rcConfig } = rc(
+  const { configs, config, ...rcConfig } = rc(
     "npm",
-    { registry: "https://registry.npmjs.org/" },
+    { registry: OFFICIAL_REGISTRY },
     { config: NPM_CONFIG_USERCONFIG || path.resolve(cwd, ".npmrc") }
   );
 

lib/trusted-publishing/oidc-context.js

@@ -0,0 +1,6 @@
+import { OFFICIAL_REGISTRY } from "../definitions/constants.js";
+import exchangeToken from "./token-exchange.js";
+
+export default async function oidcContextEstablished(registry, pkg, context) {
+  return OFFICIAL_REGISTRY === registry && !!(await exchangeToken(pkg, context));
+}