added release instructions

waikato-ufdl · Jul 18, 2023 · b309dee · b309dee
1 parent 7788ffb
commit b309dee
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/pycocotools/RELEASE.md b/pycocotools/RELEASE.md
@@ -0,0 +1,30 @@
+PyPi
+====
+
+Preparation:
+
+* increment version in `setup.py`
+* commit/push all changes
+
+Commands for releasing on pypi.org (requires twine >= 1.8.0):
+
+```
+find -name "*~" -delete
+rm dist/*
+./venv/bin/python setup.py clean
+./venv/bin/python setup.py sdist
+./venv/bin/twine upload dist/*
+```
+
+
+Github
+======
+
+Steps:
+
+* start new release (version: `wai.pycocotools vX.Y.Z`)
+* enter release notes, i.e., significant changes since last release
+* upload `wai.pycocotools-X.Y.Z.tar.gz` previously generated with `setyp.py`
+* publish
+
+