[airavata-django-portal-sdk] 04/04: Notes on pushing a release to PyPI

[ma...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

machristie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/airavata-django-portal-sdk.git

commit e71e1f36c6b496aed1916a1687b1c0999ab4d806
Author: Marcus Christie <ma...@apache.org>
AuthorDate: Wed Jun 30 15:35:09 2021 -0400

    Notes on pushing a release to PyPI
---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
index afe0100..b6021bd 100644
--- a/README.md
+++ b/README.md
@@ -76,3 +76,31 @@ flake8 .
 autopep8 -i -aaa -r .
 isort .
 ```
+
+### Making a new release
+
+1. Update the version in setup.py
+2. Tag the repo with the same version, with the format `v${version_number}`. For
+   example, if the version number in setup.py is "1.2" then tag the repo with
+   "v1.2".
+
+   git tag -m VERSION VERSION
+
+3. In a clean checkout
+
+   ```
+   cd /tmp/
+   git clone /path/to/airavata-django-portal-sdk/ -b VERSION
+   python3 -m venv venv
+   source venv/bin/activate
+   python3 -m pip install --upgrade build
+   python3 -m build
+   ```
+
+4. Push to pypi.org. Optionally can push to test.pypi.org. See
+   <https://packaging.python.org/tutorials/packaging-projects/> for more info.
+
+   ```
+   python3 -m pip install --upgrade twine
+   python3 -m twine upload dist/*
+   ```