Skip to content

Commit 8d45679

Browse files
committed
Update release instructions to mention release branch creation
Signed-off-by: Ivan Kanakarakis <[email protected]>
1 parent 58138e0 commit 8d45679

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

release-howto.rst

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,26 @@ When releasing a new version, the following steps should be taken:
2020
the long description nicely. It will treat it as plain text instead.
2121

2222
3. Update the version in the VERSION_ file and report the changes in
23-
CHANGELOG.rst_ and commit the changes.::
23+
CHANGELOG.md_ and commit the changes.::
2424

25+
git add CHANGELOG.md
26+
git add VERSION
2527
git commit -v -s -m "Release version X.Y.Z"
2628

27-
4. Create a release tag_::
29+
4. Create a release branch_::
30+
31+
git branch vX.Y.Z
32+
33+
5. Create a release tag_::
2834

2935
git tag -a -s vX.Y.Z -m "Version X.Y.Z"
3036

31-
5. Push these changes to Github::
37+
6. Push these changes to Github::
3238

3339
git push --follow-tags origin vX.Y.Z
40+
git push --follow-tags origin vX.Y.Z:vX.Y.Z
3441

35-
6. Create a source and wheel distribution and upload it to PyPI::
42+
7. Create a source and wheel distribution and upload it to PyPI::
3643

3744
# generate a source and wheel distribution at once
3845
python setup.py sdist bdist_wheel
@@ -46,7 +53,7 @@ When releasing a new version, the following steps should be taken:
4653
# then, upload release on official pypi.org
4754
twine upload dist/pysaml2-X.Y.Z*
4855

49-
7. Upload the documentation to PyPI. First you need to generate the html
56+
8. Upload the documentation to PyPI. First you need to generate the html
5057
version of the documentation::
5158

5259
cd docs/
@@ -57,7 +64,7 @@ When releasing a new version, the following steps should be taken:
5764

5865
Submit the generated pysaml2-docs.zip file.
5966

60-
8. Send an email to the pysaml2 list announcing this release
67+
9. Send an email to the pysaml2 list announcing this release
6168

6269

6370
**Important:** Once released to PyPI or any other public download location,
@@ -66,11 +73,8 @@ release ("brown bag release"). In such a case it should simply be superseded
6673
immediately by a new, improved release.
6774

6875

69-
This document is based on zope release-software_ guidelines.
70-
71-
7276
.. _VERSION: https://github.com/IdentityPython/pysaml2/blob/master/VERSION
73-
.. _CHANGELOG.rst: https://github.com/IdentityPython/pysaml2/blob/master/CHANGELOG.rst
77+
.. _CHANGELOG.md: https://github.com/IdentityPython/pysaml2/blob/master/CHANGELOG.md
7478
.. _docutils: http://docutils.sourceforge.net/
79+
.. _branch: https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell
7580
.. _tag: https://git-scm.com/book/en/v2/Git-Basics-Tagging#_annotated_tags
76-
.. _release-software: https://zopetoolkit.readthedocs.io/en/latest/process/releasing-software.html

0 commit comments

Comments
 (0)