You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- npm Trusted Publishers is supported with npm >= 11.5.1
57
+
57
58
- Ensure the publish release job has `permissions`: `id-token: write` (see the [documentation](https://docs.npmjs.com/generating-provenance-statements))
59
+
58
60
- Set up the Node.js version in your workflow using one of these approaches:
59
61
60
62
Using the `base-setup` action from `jupyterlab/maintainer-tools`:
Copy file name to clipboardExpand all lines: docs/source/how_to_guides/convert_repo_from_releaser.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,9 +19,9 @@ A. Prep the `jupyter_releaser` fork:
19
19
-[ ] Clone this repository onto your GitHub user account.
20
20
21
21
-[ ] 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
- npm Trusted Publishers is supported with npm >= 11.5.1
62
+
62
63
- Ensure the publish release job has `permissions`: `id-token: write` (see the [documentation](https://docs.npmjs.com/generating-provenance-statements))
64
+
63
65
- Set up the Node.js version in your workflow using one of these approaches:
64
66
65
67
Using the `base-setup` action from `jupyterlab/maintainer-tools`:
@@ -97,7 +99,7 @@ B. Prep target repository:
97
99
- Note that [directives](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#syntax-directives) can still be used
98
100
- [ ] 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)
99
101
- [ ] 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.
101
103
- If previously providing `version_info` like `version_info = (1, 7, 0, '.dev', '0')`, use a pattern like the one below in your version file:
102
104
103
105
```python
@@ -142,7 +144,7 @@ version_info = tuple(parts)
142
144
```
143
145
144
146
- [ ] 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.
146
148
147
149
- [ ] 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).
Copy file name to clipboardExpand all lines: docs/source/how_to_guides/convert_repo_from_repo.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ See checklist below for details:
25
25
- Store the `APP_ID` and the private key in a secure location (Jupyter Vault if using a Jupyter Org)
26
26
27
27
-[ ] 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).
29
29
30
30
-[ ] Configure [Rulesets](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets) for the repository
31
31
@@ -38,7 +38,7 @@ See checklist below for details:
38
38
- Allow the GitHub App to bypass protections
39
39
40
40
-[ ] 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.
42
42
43
43
-[ ] Set up PyPI:
44
44
@@ -52,7 +52,9 @@ See checklist below for details:
- npm Trusted Publishers is supported with npm >= 11.5.1
55
+
55
56
- Ensure the publish release job has `permissions`: `id-token: write` (see the [documentation](https://docs.npmjs.com/generating-provenance-statements))
57
+
56
58
- Set up the Node.js version in your workflow using one of these approaches:
57
59
58
60
Using the `base-setup` action from `jupyterlab/maintainer-tools`:
@@ -104,7 +106,7 @@ See checklist below for details:
104
106
```
105
107
106
108
- [ ] 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.
108
110
- If previously providing `version_info` like `version_info = (1, 7, 0, '.dev', '0')`,
109
111
use a pattern like the one below in your version file:
110
112
@@ -152,7 +154,7 @@ version_info = tuple(parts)
152
154
```
153
155
154
156
- [ ] 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.
156
158
157
159
```yaml
158
160
name: Enforce PR label
@@ -182,7 +184,7 @@ jobs:
182
184
- [ ] 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
183
185
184
186
- [ ] Try the `Publish Release` process using a prerelease version on the main
0 commit comments