Skip to content

Commit 0f41610

Browse files
authored
Merge pull request #162 from RRosio/release_notes
Update package release notes
2 parents 781c6a7 + 2a8d163 commit 0f41610

File tree

1 file changed

+35
-4
lines changed

1 file changed

+35
-4
lines changed

README.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -333,8 +333,39 @@ Remove tests dependency on `ipython_genutils`
333333
-----
334334
First public release!
335335

336-
Release
337-
=======
336+
</br>
337+
</br>
338+
339+
Making a new release of jupyter_nbextensions_configurator
340+
=========================================================
341+
This extension can be manually distributed as a Python package.
342+
343+
</br>
344+
345+
Manually bumb the package version in:
346+
* `version` and `download_url` in `setup.py`
347+
* `current_version` in `.bumpversion.cfg`
348+
* `__version__` in `src/jupyter_nbextensions_configurator/__init__.py`
349+
350+
351+
Update the Changes section of the this README with notes for the release.
352+
353+
To create the binary package (`.whl`) in the `dist/` directory, do:
354+
```bash
355+
python setup.py bdist_wheel
356+
```
357+
358+
Commit the changes to the repository, and upload artifacts.
359+
360+
Install the necessary `twine` python package
361+
```bash
362+
pip install twine
363+
```
364+
365+
Then to upload the package to PyPI, do:
366+
```bash
367+
twine upload dist/*
368+
```
338369

339-
python setup.py bdist_wheel
340-
twine upload dist/*
370+
Lastly, you can follow the instructions [here](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)
371+
to make a manual release on Github via [`jupyter_nbextensions_configurator/releases`](https://github.com/jupyter-contrib/jupyter_nbextensions_configurator/releases).

0 commit comments

Comments
 (0)