|
1 | | -# Making a new release of jupytergis |
| 1 | +Please view our releasing guide on ReadTheDocs: |
2 | 2 |
|
3 | | -The extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser). |
4 | | - |
5 | | -## Manual release |
6 | | - |
7 | | -### Python package |
8 | | - |
9 | | -This extension can be distributed as Python |
10 | | -packages. All of the Python |
11 | | -packaging instructions in the `pyproject.toml` file to wrap your extension in a |
12 | | -Python package. Before generating a package, we first need to install `build`. |
13 | | - |
14 | | -```bash |
15 | | -pip install build twine |
16 | | -``` |
17 | | - |
18 | | -To create a Python source package (`.tar.gz`) and the binary package (`.whl`) in the `dist/` directory, do: |
19 | | - |
20 | | -```bash |
21 | | -python -m build |
22 | | -``` |
23 | | - |
24 | | -> `python setup.py sdist bdist_wheel` is deprecated and will not work for this package. |
25 | | -
|
26 | | -Then to upload the package to PyPI, do: |
27 | | - |
28 | | -```bash |
29 | | -twine upload dist/* |
30 | | -``` |
31 | | - |
32 | | -### NPM package |
33 | | - |
34 | | -To publish the frontend part of the extension as a NPM package, do: |
35 | | - |
36 | | -```bash |
37 | | -npm login |
38 | | -npm publish --access public |
39 | | -``` |
40 | | - |
41 | | -## Automated releases with the Jupyter Releaser |
42 | | - |
43 | | -The extension repository should already be compatible with the Jupyter Releaser. |
44 | | - |
45 | | -Check out the [workflow documentation](https://github.com/jupyter-server/jupyter_releaser#typical-workflow) for more information. |
46 | | - |
47 | | -Here is a summary of the steps to cut a new release: |
48 | | - |
49 | | -- Fork the [`jupyter-releaser` repo](https://github.com/jupyter-server/jupyter_releaser) |
50 | | -- Add `ADMIN_GITHUB_TOKEN`, `PYPI_TOKEN` and `NPM_TOKEN` to the Github Secrets in the fork |
51 | | -- Go to the Actions panel |
52 | | -- Run the "Draft Changelog" workflow |
53 | | -- Merge the Changelog PR |
54 | | -- Run the "Draft Release" workflow |
55 | | -- Run the "Publish Release" workflow |
56 | | - |
57 | | -## Publishing to `conda-forge` |
58 | | - |
59 | | -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 |
60 | | - |
61 | | -Otherwise a bot should pick up the new version publish to PyPI, and open a new PR on the feedstock repository automatically. |
| 3 | +<https://jupytergis.readthedocs.io/en/latest/contributor_guide/releasing.html> |
0 commit comments