Skip to content

Commit e2675f7

Browse files
committed
Update release instructions
Signed-off-by: Ivan Kanakarakis <[email protected]>
1 parent b8c84ec commit e2675f7

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

release-howto.rst

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,32 @@ When releasing a new version, the following steps should be taken:
2222
If this will produce warning or errors, PyPI will be unable to render
2323
the long description nicely. It will treat it as plain text instead.
2424

25-
4. Update the version in the VERSION_ file and commit the change.
25+
4. Update the version in the VERSION_ file and report the changes in
26+
CHANGELOG.rst_ and commit the changes.::
27+
28+
git commit -v -s -m "Release version X.Y.Z"
2629

2730
5. Create a release tag_::
2831

29-
git tag -a vX.Y.Z -m "Release of version X.Y.Z"
32+
git tag -a -s vX.Y.Z -m "Version X.Y.Z"
3033

3134
6. Push these changes to Github::
3235

33-
git push origin vX.Y.Z
36+
git push --follow-tags origin vX.Y.Z
37+
38+
7. Create a source and wheel distribution and upload it to PyPI::
39+
40+
# generate a source and wheel distribution at once
41+
python setup.py sdist bdist_wheel
42+
43+
# generated files are under dist/
44+
ls dist/
3445

35-
7. Create a source distribution and upload it to PyPI using the following
36-
command::
46+
# upload release on test.pypi.org
47+
twine upload --repository-url https://test.pypi.org/legacy/ dist/pysaml2-X.Y.Z*
3748

38-
python setup.py register sdist upload
49+
# then, upload release on official pypi.org
50+
twine upload dist/pysaml2-X.Y.Z*
3951

4052
8. Upload the documentation to PyPI. First you need to generate the html
4153
version of the documentation::
@@ -60,6 +72,8 @@ immediately by a new, improved release.
6072
This document is based on zope release-software_ guidelines.
6173

6274

75+
.. _VERSION: https://github.com/IdentityPython/pysaml2/blob/master/VERSION
76+
.. _CHANGELOG.rst: https://github.com/IdentityPython/pysaml2/blob/master/CHANGELOG.rst
6377
.. _docutils: http://docutils.sourceforge.net/
6478
.. _tag: https://git-scm.com/book/en/v2/Git-Basics-Tagging#_annotated_tags
6579
.. _release-software: https://zopetoolkit.readthedocs.io/en/latest/process/releasing-software.html

0 commit comments

Comments
 (0)