@@ -20,19 +20,26 @@ When releasing a new version, the following steps should be taken:
20
20
the long description nicely. It will treat it as plain text instead.
21
21
22
22
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.::
24
24
25
+ git add CHANGELOG.md
26
+ git add VERSION
25
27
git commit -v -s -m "Release version X.Y.Z"
26
28
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 _::
28
34
29
35
git tag -a -s vX.Y.Z -m "Version X.Y.Z"
30
36
31
- 5 . Push these changes to Github::
37
+ 6 . Push these changes to Github::
32
38
33
39
git push --follow-tags origin vX.Y.Z
40
+ git push --follow-tags origin vX.Y.Z:vX.Y.Z
34
41
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::
36
43
37
44
# generate a source and wheel distribution at once
38
45
python setup.py sdist bdist_wheel
@@ -46,7 +53,7 @@ When releasing a new version, the following steps should be taken:
46
53
# then, upload release on official pypi.org
47
54
twine upload dist/pysaml2-X.Y.Z*
48
55
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
50
57
version of the documentation::
51
58
52
59
cd docs/
@@ -57,7 +64,7 @@ When releasing a new version, the following steps should be taken:
57
64
58
65
Submit the generated pysaml2-docs.zip file.
59
66
60
- 8 . Send an email to the pysaml2 list announcing this release
67
+ 9 . Send an email to the pysaml2 list announcing this release
61
68
62
69
63
70
**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
66
73
immediately by a new, improved release.
67
74
68
75
69
- This document is based on zope release-software _ guidelines.
70
-
71
-
72
76
.. _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
74
78
.. _docutils : http://docutils.sourceforge.net/
79
+ .. _branch : https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell
75
80
.. _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