Skip to content

Commit 1fa651d

Browse files
committed
Added releasing document to follow for releases
1 parent 8b2fb3e commit 1fa651d

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

RELEASING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Releasing
2+
3+
## Prerequisites
4+
5+
- First check that the changelog.rst is up to date for the next release version
6+
7+
## Bump version
8+
9+
- Load `jupyter_client/_version.py` and remove the 'dev' tag
10+
- Change from patch to minor or major for appropriate version updates.
11+
- `git commit -am "Bumped version for release"`
12+
- `git tag {new version here}`
13+
14+
## Push to PyPI
15+
16+
```bash
17+
rm -rf dist/*
18+
rm -rf build/*
19+
python setup.py sdist bdist_wheel
20+
# You should probably also test downstream libraries against each of the artifacts produced as this isn't tested in the project atm
21+
twine upload dist/*
22+
```
23+
24+
## Dev version
25+
26+
- Load `jupyter_client/_version.py` and bump the patch version and add the 'dev' tag back to the end of the version tuple.
27+
28+
29+
## Push to GitHub
30+
31+
```bash
32+
33+
git commit -am "Added dev back to version".
34+
git push && git push --tags
35+
```

0 commit comments

Comments
 (0)