diff --git a/docs/source/get_started/making_release_from_releaser.md b/docs/source/get_started/making_release_from_releaser.md index 3f395529..83e5b011 100644 --- a/docs/source/get_started/making_release_from_releaser.md +++ b/docs/source/get_started/making_release_from_releaser.md @@ -49,9 +49,42 @@ already uses Jupyter Releaser. -- If the repo generates npm release(s), add access token for [npm](https://docs.npmjs.com/creating-and-viewing-access-tokens), saved as `NPM_TOKEN` in "Secrets". +- If the repo generates npm release(s), set up npm: -> If you want to set _provenance_ on your package, you need to ensure the publish release job as `permissions`: `id-token : write` (see the [documentation](https://docs.npmjs.com/generating-provenance-statements#publishing-packages-with-provenance-via-github-actions)). +
Using npm Trusted Publishers (recommended) + +- npm Trusted Publishers is supported with npm >= 11.5.1 + +- Ensure the publish release job has `permissions`: `id-token: write` (see the [documentation](https://docs.npmjs.com/generating-provenance-statements)) + +- Set up the Node.js version in your workflow using one of these approaches: + + Using the `base-setup` action from `jupyterlab/maintainer-tools`: + + ```yaml + - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1 + with: + node_version: "24" + ``` + + Or using the standard `setup-node` action: + + ```yaml + - uses: actions/setup-node@v6 + with: + node-version: "24" + ``` + +- With Trusted Publishers enabled, npm packages will be published without needing to store an `NPM_TOKEN` secret + +
+ +
Using NPM_TOKEN (legacy way) + +- Create an access token for [npm](https://docs.npmjs.com/creating-and-viewing-access-tokens), saved as `NPM_TOKEN` in "Secrets" +- If you want to set _provenance_ on your package, you need to ensure the publish release job has `permissions`: `id-token: write` (see the [documentation](https://docs.npmjs.com/generating-provenance-statements#publishing-packages-with-provenance-via-github-actions)) + +
## Prep Release diff --git a/docs/source/how_to_guides/convert_repo_from_releaser.md b/docs/source/how_to_guides/convert_repo_from_releaser.md index 0c1cf2f6..726e57f2 100644 --- a/docs/source/how_to_guides/convert_repo_from_releaser.md +++ b/docs/source/how_to_guides/convert_repo_from_releaser.md @@ -10,7 +10,7 @@ See checklist below for details: - Bump version configuration (if using Python), for example [tbump](https://github.com/dmerejkowsky/tbump) - [Access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) with access to target GitHub repo to run GitHub Actions. - Access token for the [PyPI registry](https://packaging.python.org/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/#saving-credentials-on-github) -- If needed, access token for [npm](https://docs.npmjs.com/creating-and-viewing-access-tokens). +- If publishing to npm, we recommend using [npm Trusted Publishers](https://docs.npmjs.com/trusted-publishers) (requires npm >= 11.5.1, available via Node.js >= 24). Otherwise, create an access token for [npm](https://docs.npmjs.com/creating-and-viewing-access-tokens). ## Checklist for Adoption @@ -54,9 +54,42 @@ A. Prep the `jupyter_releaser` fork: -- [ ] If needed, add access token for [npm](https://docs.npmjs.com/creating-and-viewing-access-tokens), saved as `NPM_TOKEN`. +- [ ] Set up npm (if publishing to npm): -> If you want to set _provenance_ on your package, you need to ensure the publish release job as `permissions`: `id-token : write` (see the [documentation](https://docs.npmjs.com/generating-provenance-statements#publishing-packages-with-provenance-via-github-actions)). +
Using npm Trusted Publishers (recommended) + +- npm Trusted Publishers is supported with npm >= 11.5.1 + +- Ensure the publish release job has `permissions`: `id-token: write` (see the [documentation](https://docs.npmjs.com/generating-provenance-statements)) + +- Set up the Node.js version in your workflow using one of these approaches: + + Using the `base-setup` action from `jupyterlab/maintainer-tools`: + + ```yaml + - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1 + with: + node_version: "24" + ``` + + Or using the standard `setup-node` action: + + ```yaml + - uses: actions/setup-node@v4 + with: + node-version: "24" + ``` + +- With Trusted Publishers enabled, npm packages will be published with provenance automatically, without needing to store an `NPM_TOKEN` secret + +
+ +
Using NPM_TOKEN (legacy way) + +- Create an access token for [npm](https://docs.npmjs.com/creating-and-viewing-access-tokens), saved as `NPM_TOKEN` +- If you want to set _provenance_ on your package, you need to ensure the publish release job has `permissions`: `id-token: write` (see the [documentation](https://docs.npmjs.com/generating-provenance-statements#publishing-packages-with-provenance-via-github-actions)) + +
B. Prep target repository: diff --git a/docs/source/how_to_guides/convert_repo_from_repo.md b/docs/source/how_to_guides/convert_repo_from_repo.md index cae7bc50..1ae90712 100644 --- a/docs/source/how_to_guides/convert_repo_from_repo.md +++ b/docs/source/how_to_guides/convert_repo_from_repo.md @@ -9,7 +9,7 @@ See checklist below for details: - Markdown changelog - Bump version configuration (if using Python), for example [hatch](https://hatch.pypa.io/latest/) - [Add a trusted publisher](https://docs.pypi.org/trusted-publishers/adding-a-publisher/) to your PyPI project -- If needed, access token for [npm](https://docs.npmjs.com/creating-and-viewing-access-tokens). +- If publishing to npm, we recommend using [npm Trusted Publishers](https://docs.npmjs.com/trusted-publishers) (requires npm >= 11.5.1, available via Node.js >= 24). Otherwise, create an access token for [npm](https://docs.npmjs.com/creating-and-viewing-access-tokens). ## Checklist for Adoption @@ -47,8 +47,43 @@ See checklist below for details: _environment_ should be `release` (the name of the GitHub environment). - Ensure the publish release job as `permissions`: `id-token : write` (see the [documentation](https://docs.pypi.org/trusted-publishers/using-a-publisher/)) -- [ ] If needed, add access token for [npm](https://docs.npmjs.com/creating-and-viewing-access-tokens), saved as `NPM_TOKEN`. Again this should - be created using a machine account that only has publish access. +- [ ] Set up npm (if publishing to npm): + +
Using npm Trusted Publishers (recommended) + +- npm Trusted Publishers is supported with npm >= 11.5.1 + +- Ensure the publish release job has `permissions`: `id-token: write` (see the [documentation](https://docs.npmjs.com/generating-provenance-statements)) + +- Set up the Node.js version in your workflow using one of these approaches: + + Using the `base-setup` action from `jupyterlab/maintainer-tools`: + + ```yaml + - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1 + with: + node_version: "24" + ``` + + Or using the standard `setup-node` action: + + ```yaml + - uses: actions/setup-node@v4 + with: + node-version: "24" + ``` + +- With Trusted Publishers enabled, npm packages will be published with provenance automatically, without needing to store an `NPM_TOKEN` secret + +
+ +
Using NPM_TOKEN (legacy way) + +- Create an access token for [npm](https://docs.npmjs.com/creating-and-viewing-access-tokens), saved as `NPM_TOKEN` +- This should be created using a machine account that only has publish access +- If you want to set _provenance_ on your package, you need to ensure the publish release job has `permissions`: `id-token: write` (see the [documentation](https://docs.npmjs.com/generating-provenance-statements#publishing-packages-with-provenance-via-github-actions)) + +
- [ ] Ensure that only trusted users with 2FA have admin access to the repository, since they will be able to trigger releases. diff --git a/docs/source/reference/theory.md b/docs/source/reference/theory.md index dbe796ff..680a6f33 100644 --- a/docs/source/reference/theory.md +++ b/docs/source/reference/theory.md @@ -17,7 +17,7 @@ This project should help maintainers reduce toil and save time in the release pr We strive to use the most secure release practices possible, reflected in the `Checklist for Adoption` and the example workflows. -This includes using PyPI Trusted Publishing, using GitHub Environments, encouraging the use of Rulesets and GitHub Apps with limited bypass capability, and provenance data for npm. +This includes using PyPI Trusted Publishing, npm Trusted Publishers (with npm >= 11.5.1), using GitHub Environments, encouraging the use of Rulesets and GitHub Apps with limited bypass capability, and provenance data for npm. In addition, there is an automatic check for whether the user who triggered the action is an admin. ## Action Details diff --git a/jupyter_releaser/npm.py b/jupyter_releaser/npm.py index c9d98820..45558b5f 100644 --- a/jupyter_releaser/npm.py +++ b/jupyter_releaser/npm.py @@ -1,4 +1,5 @@ """npm-related utilities.""" + # Copyright (c) Jupyter Development Team. # Distributed under the terms of the Modified BSD License. import json @@ -153,6 +154,8 @@ def handle_npm_config(npm_token): short_reg = registry.replace("https://", "//") short_reg = short_reg.replace("http://", "//") auth_entry = f"{short_reg}:_authToken={npm_token}" + else: + util.log("No NPM_TOKEN provided, will attempt to use npm Trusted Publishers if configured") # Handle existing config if npmrc.exists(): @@ -182,13 +185,13 @@ def get_package_versions(version): npm_version = data.get("version", "") if npm_version != version: message += f"\nPython version: {version}" - message += f'\nnpm version: {data["name"]}: {npm_version}' + message += f"\nnpm version: {data['name']}: {npm_version}" if "workspaces" in data: message += "\nnpm workspace versions:" for path in _get_workspace_packages(data): text = path.joinpath("package.json").read_text(encoding="utf-8") data = json.loads(text) - message += f'\n{data["name"]}: {data.get("version", "")}' + message += f"\n{data['name']}: {data.get('version', '')}" return message