Skip to content

Commit 5a43595

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

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

release-howto.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,7 @@ When releasing a new version, the following steps should be taken:
55

66
1. Make sure all automated tests pass.
77

8-
2. Fill in the release date in ``CHANGES``. Make sure the changelog is
9-
complete. Commit this change.
10-
11-
3. Make sure the package metadata in ``setup.py`` is up-to-date. You can
8+
2. Make sure the package metadata in ``setup.py`` is up-to-date. You can
129
verify the information by re-generating the egg info::
1310

1411
python setup.py egg_info
@@ -22,20 +19,20 @@ When releasing a new version, the following steps should be taken:
2219
If this will produce warning or errors, PyPI will be unable to render
2320
the long description nicely. It will treat it as plain text instead.
2421

25-
4. Update the version in the VERSION_ file and report the changes in
22+
3. Update the version in the VERSION_ file and report the changes in
2623
CHANGELOG.rst_ and commit the changes.::
2724

2825
git commit -v -s -m "Release version X.Y.Z"
2926

30-
5. Create a release tag_::
27+
4. Create a release tag_::
3128

3229
git tag -a -s vX.Y.Z -m "Version X.Y.Z"
3330

34-
6. Push these changes to Github::
31+
5. Push these changes to Github::
3532

3633
git push --follow-tags origin vX.Y.Z
3734

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

4037
# generate a source and wheel distribution at once
4138
python setup.py sdist bdist_wheel
@@ -49,7 +46,7 @@ When releasing a new version, the following steps should be taken:
4946
# then, upload release on official pypi.org
5047
twine upload dist/pysaml2-X.Y.Z*
5148

52-
8. Upload the documentation to PyPI. First you need to generate the html
49+
7. Upload the documentation to PyPI. First you need to generate the html
5350
version of the documentation::
5451

5552
cd docs/
@@ -60,7 +57,7 @@ When releasing a new version, the following steps should be taken:
6057

6158
Submit the generated pysaml2-docs.zip file.
6259

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

6562

6663
**Important:** Once released to PyPI or any other public download location,

0 commit comments

Comments
 (0)