Skip to content

Commit 36ac20f

Browse files
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent ac6491c commit 36ac20f

File tree

3 files changed

+18
-10
lines changed

3 files changed

+18
-10
lines changed

docs/source/get_started/making_release_from_releaser.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,17 +54,21 @@ already uses Jupyter Releaser.
5454
<details><summary>Using npm Trusted Publishers (recommended)</summary>
5555
5656
- npm Trusted Publishers is supported with npm >= 11.5.1
57+
5758
- Ensure the publish release job has `permissions`: `id-token: write` (see the [documentation](https://docs.npmjs.com/generating-provenance-statements))
59+
5860
- Set up the Node.js version in your workflow using one of these approaches:
5961
6062
Using the `base-setup` action from `jupyterlab/maintainer-tools`:
63+
6164
```yaml
6265
- uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
6366
with:
6467
node_version: "24"
6568
```
6669

6770
Or using the standard `setup-node` action:
71+
6872
```yaml
6973
- uses: actions/setup-node@v6
7074
with:

docs/source/how_to_guides/convert_repo_from_releaser.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ A. Prep the `jupyter_releaser` fork:
1919
- [ ] Clone this repository onto your GitHub user account.
2020

2121
- [ ] Add a GitHub [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) with access to target GitHub repo to run
22-
GitHub Actions, saved as `ADMIN_GITHUB_TOKEN` in the
23-
[repository secrets](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository).
24-
The token will need "public_repo", and "repo:status" permissions.
22+
GitHub Actions, saved as `ADMIN_GITHUB_TOKEN` in the
23+
[repository secrets](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository).
24+
The token will need "public_repo", and "repo:status" permissions.
2525

2626
- [ ] Set up PyPI:
2727

@@ -59,7 +59,9 @@ A. Prep the `jupyter_releaser` fork:
5959
<details><summary>Using npm Trusted Publishers (recommended)</summary>
6060

6161
- npm Trusted Publishers is supported with npm >= 11.5.1
62+
6263
- Ensure the publish release job has `permissions`: `id-token: write` (see the [documentation](https://docs.npmjs.com/generating-provenance-statements))
64+
6365
- Set up the Node.js version in your workflow using one of these approaches:
6466

6567
Using the `base-setup` action from `jupyterlab/maintainer-tools`:
@@ -97,7 +99,7 @@ B. Prep target repository:
9799
- Note that [directives](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#syntax-directives) can still be used
98100
- [ ] Add HTML start and end comment markers to Changelog file - see example in [CHANGELOG.md](https://github.com/jupyter-server/jupyter_releaser/blob/main/CHANGELOG.md) (view in raw mode)
99101
- [ ] We recommend using [hatch](https://hatch.pypa.io/latest/) for your
100-
build system and for version handling.
102+
build system and for version handling.
101103
- If previously providing `version_info` like `version_info = (1, 7, 0, '.dev', '0')`, use a pattern like the one below in your version file:
102104

103105
```python
@@ -142,7 +144,7 @@ version_info = tuple(parts)
142144
```
143145

144146
- [ ] Add a workflow that uses the [`enforce-label`](https://github.com/jupyterlab/maintainer-tools#enforce-labels) action from `jupyterlab/maintainer-tools` to ensure that all PRs have on of the triage labels used to
145-
categorize the changelog.
147+
categorize the changelog.
146148

147149
- [ ] Update or add `RELEASE.md` that describes the onboarding and release process, e.g. [jupyter_server](https://github.com/jupyter-server/jupyter_server/blob/main/RELEASE.md).
148150

docs/source/how_to_guides/convert_repo_from_repo.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ See checklist below for details:
2525
- Store the `APP_ID` and the private key in a secure location (Jupyter Vault if using a Jupyter Org)
2626

2727
- [ ] Create a "release" [environment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment) on your repository and add an `APP_ID` Environment Variable and `APP_PRIVATE_KEY` secret.
28-
The environment should be enabled for ["Protected branches only"](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-branches-and-tags).
28+
The environment should be enabled for ["Protected branches only"](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-branches-and-tags).
2929

3030
- [ ] Configure [Rulesets](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets) for the repository
3131

@@ -38,7 +38,7 @@ See checklist below for details:
3838
- Allow the GitHub App to bypass protections
3939

4040
- [ ] Copy `prep-release.yml` and `publish-release.yml` (or only `full-release.yml`) from the
41-
[example-workflows](https://github.com/jupyter-server/jupyter_releaser/tree/main/example-workflows) folder in this repository.
41+
[example-workflows](https://github.com/jupyter-server/jupyter_releaser/tree/main/example-workflows) folder in this repository.
4242

4343
- [ ] Set up PyPI:
4444

@@ -52,7 +52,9 @@ See checklist below for details:
5252
<details><summary>Using npm Trusted Publishers (recommended)</summary>
5353

5454
- npm Trusted Publishers is supported with npm >= 11.5.1
55+
5556
- Ensure the publish release job has `permissions`: `id-token: write` (see the [documentation](https://docs.npmjs.com/generating-provenance-statements))
57+
5658
- Set up the Node.js version in your workflow using one of these approaches:
5759

5860
Using the `base-setup` action from `jupyterlab/maintainer-tools`:
@@ -104,7 +106,7 @@ See checklist below for details:
104106
```
105107

106108
- [ ] We recommend using [hatch](https://hatch.pypa.io/latest/) for your
107-
build system and for version handling.
109+
build system and for version handling.
108110
- If previously providing `version_info` like `version_info = (1, 7, 0, '.dev', '0')`,
109111
use a pattern like the one below in your version file:
110112

@@ -152,7 +154,7 @@ version_info = tuple(parts)
152154
```
153155

154156
- [ ] Add a workflow that uses the [`enforce-label`](https://github.com/jupyterlab/maintainer-tools#enforce-labels) action
155-
from `jupyterlab/maintainer-tools` to ensure that all PRs have on of the triage labels used to categorize the changelog.
157+
from `jupyterlab/maintainer-tools` to ensure that all PRs have on of the triage labels used to categorize the changelog.
156158

157159
```yaml
158160
name: Enforce PR label
@@ -182,7 +184,7 @@ jobs:
182184
- [ ] Try out the `Prep Release` and `Publish Release` process against a fork of the target repo first so you don't accidentally push tags and GitHub releases to the source repository. Set the `TWINE_REPOSITORY_URL` environment variable to `https://test.pypi.org/legacy/` in the "Finalize Release" action part of the workflow
183185

184186
- [ ] Try the `Publish Release` process using a prerelease version on the main
185-
repository before publishing a final version.
187+
repository before publishing a final version.
186188

187189
## Backport Branches
188190

0 commit comments

Comments
 (0)