Skip to content

Commit 8576692

Browse files
docs: improve release by making it easier to copy paste commands
1 parent 17f99c8 commit 8576692

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/source/dev_release.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@ Lerna will prompt you for version numbers for each of the changed npm packages i
6060
Go into the `python/jupyterlab_widgets` directory. Change `jupyterlab_widgets/_version.py` to reflect the new version number.
6161

6262
```
63-
python -m build
64-
twine upload dist/*
63+
(python/jupyterlab_widgets && python -m build && twine upload dist/*)
6564
```
6665

6766
Verify that the package is uploaded.
@@ -75,8 +74,7 @@ curl -s https://pypi.org/pypi/jupyterlab-widgets/json | jq -r '[.releases[][] |
7574
Go into the `python/widgetsnbextension` directory. Change `widgetsnbextension/_version.py` to reflect the new version number.
7675

7776
```
78-
python -m build
79-
twine upload dist/*
77+
(cd python/widgetsnbextension && python -m build && twine upload dist/*)
8078
```
8179

8280
Verify that the package is uploaded.
@@ -90,8 +88,7 @@ curl -s https://pypi.org/pypi/widgetsnbextension/json | jq -r '[.releases[][] |
9088
Go into the `python/ipywidgets` directory. Change `ipywidgets/_version.py` to reflect the new version number, and if necessary, a new `__html_manager_version__`. Change the `install_requires` parameter in `setup.cfg` reference the new widgetsnbextension and jupyterlab_widgets version.
9189

9290
```
93-
python -m build
94-
twine upload dist/*
91+
(cd python/ipywidgets && python -m build && twine upload dist/*)
9592
```
9693

9794
Verify that the package is uploaded:
@@ -124,7 +121,13 @@ Using the above script, you can do:
124121
./scripts/hashes python/jupyterlab_widgets/dist/*
125122
```
126123

127-
Commit the changes you've made above, and include the uploaded files hashes in the commit message. Tag the release if ipywidgets was released. Push to origin master (and include the tag in the push).
124+
Commit the changes you've made above, and include the uploaded files hashes in the commit message. Tag the release if ipywidgets was released. Push to origin master (and include the tag in the push), e.g:
125+
126+
```
127+
git tag 8.0.4
128+
git push origin master 8.0.4
129+
```
130+
128131

129132
Update conda-forge packages (if the requirements changed to ipywidgets, make sure to update widgetsnbextension first).
130133

0 commit comments

Comments
 (0)