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
* Updated release instructions
* Ensures labels are added to PRs
* Updated check-release wflow to run only after merge to main
* Bumped python and node versions to current.
Copy file name to clipboardExpand all lines: RELEASE.md
+42-17Lines changed: 42 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,20 @@
2
2
3
3
The extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).
4
4
5
+
## Automated releases with the Jupyter Releaser
6
+
7
+
The extension repository should already be compatible with the Jupyter Releaser.
8
+
9
+
Check out the [workflow documentation](https://github.com/jupyter-server/jupyter_releaser#typical-workflow) for more information.
10
+
11
+
Here is a summary of the steps to cut a new release:
12
+
13
+
- Fork the [`jupyter-releaser` repo](https://github.com/jupyter-server/jupyter_releaser)
14
+
- Add `ADMIN_GITHUB_TOKEN`, `PYPI_TOKEN` and `NPM_TOKEN` to the Github Secrets in the fork
15
+
- Go to the Actions panel
16
+
- Run the "Step 1: Prep Release" workflow, this will create a draft release in github for review
17
+
- Run the "Step 2: Publish Release" workflow
18
+
5
19
## Manual release
6
20
7
21
### Python package
@@ -15,10 +29,37 @@ Python package. Before generating a package, we first need to install `build`.
15
29
pip install build twine tbump
16
30
```
17
31
32
+
Make sure you have checked out the `main` branch updated from remote.
33
+
34
+
```bash
35
+
git checkout main
36
+
git remote update
37
+
git pull upstream main
38
+
```
39
+
18
40
Bump the version using `tbump`. By default this will create a tag.
19
41
20
42
```bash
21
-
tbump <new-version>
43
+
tbump --no-push <new-version>
44
+
```
45
+
46
+
Push the bump version commit and tag to main upstream branch.
47
+
48
+
```bash
49
+
git push upstream main
50
+
git push upstream <new-version-tag>
51
+
```
52
+
53
+
Checkout the new tagged commit.
54
+
55
+
```bash
56
+
git checkout <new-version-tag>
57
+
```
58
+
59
+
Build the extension
60
+
61
+
```bash
62
+
jlpm run build:prod
22
63
```
23
64
24
65
To create a Python source package (`.tar.gz`) and the binary package (`.whl`) in the `dist/` directory, do:
@@ -44,22 +85,6 @@ npm login
44
85
npm publish --access public
45
86
```
46
87
47
-
## Automated releases with the Jupyter Releaser
48
-
49
-
The extension repository should already be compatible with the Jupyter Releaser.
50
-
51
-
Check out the [workflow documentation](https://github.com/jupyter-server/jupyter_releaser#typical-workflow) for more information.
52
-
53
-
Here is a summary of the steps to cut a new release:
54
-
55
-
- Fork the [`jupyter-releaser` repo](https://github.com/jupyter-server/jupyter_releaser)
56
-
- Add `ADMIN_GITHUB_TOKEN`, `PYPI_TOKEN` and `NPM_TOKEN` to the Github Secrets in the fork
57
-
- Go to the Actions panel
58
-
- Run the "Draft Changelog" workflow
59
-
- Merge the Changelog PR
60
-
- Run the "Draft Release" workflow
61
-
- Run the "Publish Release" workflow
62
-
63
88
## Publishing to `conda-forge`
64
89
65
90
If the package is not on conda forge yet, check the documentation to learn how to add it: https://conda-forge.org/docs/maintainer/adding_pkgs.html
0 commit comments