From e4f89c93b5978329b6e5d13bd5dbb20378cc0f66 Mon Sep 17 00:00:00 2001 From: Hossein Shafagh Date: Mon, 16 Nov 2020 16:31:50 -0800 Subject: [PATCH] updating the release docs --- docs/doing-a-release.rst | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst index 71268b10..747668fb 100644 --- a/docs/doing-a-release.rst +++ b/docs/doing-a-release.rst @@ -21,12 +21,37 @@ The commit that merged the version number bump is now the official release commit for this release. You need an `API key `_, which requires permissions to maintain the Lemur `project `_. +For creating the release, follow these steps (more details `here `_) + +* Make sure you have the latest versions of setuptools and wheel installed: + + ``python3 -m pip install --user --upgrade setuptools wheel`` + +* Now run this command from the same directory where setup.py is located: + + ``python3 setup.py sdist bdist_wheel`` + +* Once completed it should generate two files in the dist directory: + +.. code-block:: pycon + + $ ls dist/ + lemur-0.8.0-py2.py3-none-any.whl lemur-0.8.0.tar.gz + + +* In this step, the distribution will be uploaded. You’ll need to install Twine: + ``python3 -m pip install --user --upgrade twine`` + +* Once installed, run Twine to upload all of the archives under dist. Once installed, run Twine to upload all of the archives under dist: + ``python3 -m twine upload --repository pypi dist/*`` -The release should now be available on PyPI and a tag should be available in +The release should now be available on `PyPI Lemur `_ and a tag should be available in the repository. +Make sure to also make a github `release `_ which will pick up the latest version. + Verifying the release ---------------------