Skip to content

Commit b561e73

Browse files
author
Steven Silvester
committed
Add release instructions
cleanup Add more instructions formatting cleanup formatting
1 parent e577b6c commit b561e73

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

RELEASE.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Making a Release of Notebook
2+
3+
## Start from a fresh git checkout and conda environment
4+
5+
### Set the release branch
6+
7+
```bash
8+
export release_branch=master
9+
```
10+
11+
### Create the git checkout
12+
13+
```bash
14+
git clone [email protected]:jupyter/notebook.git
15+
cd notebook
16+
git checkout ${release_banch}
17+
```
18+
19+
### Create and activate the conda environment
20+
21+
```bash
22+
conda create -n notebook-release -c conda-forge jupyter
23+
conda activate notebook-release
24+
```
25+
26+
## Perform a local dev install
27+
28+
```bash
29+
pip install -ve .
30+
```
31+
32+
## Install release dependencies
33+
34+
```bash
35+
conda install -c conda-forge nodejs babel twine
36+
npm install -g po2json
37+
```
38+
39+
## Update the version
40+
41+
```bash
42+
vim notebook/_version.py
43+
git commit -am "Release $(python setup.py --version)"
44+
git tag $(python setup.py --version)
45+
```
46+
47+
## Create the artifacts
48+
49+
```bash
50+
rm -rf dist
51+
python setup.py sdist
52+
python setup.py bdist_wheel
53+
```
54+
55+
## Upload the artifacts
56+
57+
```bash
58+
twine check dist/* && twine upload dist/*
59+
```
60+
61+
## Change back to dev version
62+
63+
```bash
64+
vim notebook/_version.py
65+
git commit -am "Back to dev version"
66+
```
67+
68+
## Push the commits and tags
69+
70+
```bash
71+
git push origin ${release_branch} --tags
72+
```

0 commit comments

Comments
 (0)