Skip to content

Commit 7377a1e

Browse files
committed
Update release instructions and dev version
1 parent 8763b5b commit 7377a1e

File tree

2 files changed

+32
-4
lines changed

2 files changed

+32
-4
lines changed

RELEASE.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,40 @@
1-
To create a release, update the version number in jupyter_server/_version.py, then run the following:
1+
# Making a Jupyter Server Release
2+
To create a release, perform the following steps...
23

4+
## Remove untracked files
35
```
46
git clean -dffx
5-
python setup.py sdist
6-
python setup.py bdist_wheel
7+
```
8+
9+
## Update the version and apply the tag
10+
```
11+
vim jupyter_server/_version.py
712
export script_version=`python setup.py --version 2>/dev/null`
813
git commit -a -m "Release $script_version"
914
git tag $script_version
15+
```
16+
17+
## Build the artifacts
18+
```
19+
rm -rf dist
20+
python setup.py sdist
21+
python setup.py bdist_wheel
22+
```
23+
24+
## Update the version back to dev
25+
```
26+
vim jupyter_server/_version.py
27+
git commit -a -m "Back to dev version"
28+
```
29+
30+
## Push the commits and tag
31+
```
1032
git push --all
1133
git push --tags
34+
```
35+
36+
## Publish the artifacts to pypi
37+
```
1238
pip install twine
1339
twine check dist/*
1440
twine upload dist/*

jupyter_server/_version.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
# patch the JavaScript files in `.postN` release done by distributions.
99

1010
# Next beta/alpha/rc release: The version number for beta is X.Y.ZbN **without dots**.
11+
# However, be sure to INCLUDE a dot prefix when adding the dev release: X.Y.Z.devN
12+
# See: https://www.python.org/dev/peps/pep-0440/#public-version-identifiers
1113

12-
version_info = (1, 1, 0, 'dev0')
14+
version_info = (1, 1, 0, '.dev0')
1315
__version__ = '.'.join(map(str, version_info[:3])) + ''.join(version_info[3:])

0 commit comments

Comments
 (0)