Merge pull request #348 from kevin-bates/update-release-instructions

Update release instructions and dev version

Author: Zsailer

RELEASE.md

@@ -1,14 +1,40 @@
-To create a release, update the version number in jupyter_server/_version.py, then run the following:
+# Making a Jupyter Server Release
+To create a release, perform the following steps...
 
+## Remove untracked files
 ```
 git clean -dffx
-python setup.py sdist
-python setup.py bdist_wheel
+```
+
+## Update the version and apply the tag
+```
+vim jupyter_server/_version.py
 export script_version=`python setup.py --version 2>/dev/null`
 git commit -a -m "Release $script_version"
 git tag $script_version
+```
+
+## Build the artifacts
+```
+rm -rf dist
+python setup.py sdist
+python setup.py bdist_wheel
+```
+
+## Update the version back to dev
+```
+vim jupyter_server/_version.py
+git commit -a -m "Back to dev version"
+```
+
+## Push the commits and tag
+```
 git push --all
 git push --tags
+```
+
+## Publish the artifacts to pypi
+```
 pip install twine
 twine check dist/* 
 twine upload dist/*

jupyter_server/_version.py

@@ -8,6 +8,8 @@
 # patch the JavaScript files in `.postN` release done by distributions.
 
 # Next beta/alpha/rc release: The version number for beta is X.Y.ZbN **without dots**.
+# However, be sure to INCLUDE a dot prefix when adding the dev release: X.Y.Z.devN
+# See: https://www.python.org/dev/peps/pep-0440/#public-version-identifiers
 
-version_info = (1, 1, 0, 'dev0')
+version_info = (1, 1, 0, '.dev0')
 __version__ = '.'.join(map(str, version_info[:3])) + ''.join(version_info[3:])