document release process

KomodoPlatform · Dec 10, 2020 · f9fec22 · f9fec22
1 parent 9149382
commit f9fec22
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -9,6 +9,7 @@ docs/_build
 /build
 /dist
 /electrumx.egg-info
+/e_x.egg-info
 .vscode/
 .mypy_cache/
 .idea/
diff --git a/docs/release_process.txt b/docs/release_process.txt
@@ -0,0 +1,19 @@
+// 1. Add changelog
+
+// 2. Update version number, in:
+// - docs/conf.py
+// - electrumx/__init__.py
+// - setup.py
+
+// 3. Tag
+$ git tag -s VERSION -m "VERSION"
+
+// 4. Build dists
+$ python3 setup.py sdist bdist_wheel
+
+// 5. Upload to PyPI
+// python3 -m twine upload --repository testpypi dist/*
+$ python3 -m twine upload dist/*
+
+// You will be prompted for a username and password. For the username, use __token__.
+// For the password, use API token from https://pypi.org/manage/account/ , including the pypi- prefix.