1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
# Releasing
## Prerequisites
- If you have a schema version change, you need to bump the schema version manually:
First copy `nbformat/v4/nbformat/.v4.schema.json` to `nbformat/v4/nbformat/.v4.<new_minor_version_here>schema.json`.
Then edit the top of `nbformat/v4/nbbase.py`:
```python
# Change the nbformat_minor and nbformat_schema variables when incrementing the
# nbformat version
# current major version
nbformat = 4
# current minor version
nbformat_minor = new_minor_version_here
# schema files for (major, minor) version tuples. (None, None) means the current version
nbformat_schema = {
(None, None): "nbformat.v4.schema.json",
(4, 0): "nbformat.v4.0.schema.json",
# ...
(4, new_minor_version_here): "nbformat.v4.<new_minor_version_here>.schema.json",
}
```
If you do one of these steps but not the others it will fail many tests.
## Automated Release
The recommended way to make a release is to use [`jupyter_releaser`](https://github.com/jupyter-server/jupyter_releaser) from this repository.
- Run the "Step 1: Prep Release" workflow with the appropriate inputs.
- Review the changelog in the draft GitHub release created in Step 1.
## Manual Release
We use [hatch](https://hatch.pypa.io/latest/version/) to manage versions.
You must first install `pipx` (or install `hatch` itself if you prefer).
To bump versions we use the `pipx run hatch version <new_version>` command.
### To make a release
```bash
# Commit, test, publish, beta tag
pipx run hatch version <new_version>
git tag -a <new_version> -m "<new_version>"
git push upstream master
git push upstream --tags
```
### Push to PyPI
```bash
rm -rf dist/*
rm -rf build/*
pipx run build .
# Double check the dist/* files have the right version (no `.dev`) and install the wheel to ensure it's good
pip install dist/*
pipx run twine upload dist/*
```
### Push to npm
```bash
npm publish
```
Note for JavaScript developers -- `hatch` updates the version in `package.json`.
|
