From 298a21e70716ad3886a46389f21c89203e19f947 Mon Sep 17 00:00:00 2001 From: Konstantin Lopuhin Date: Tue, 1 Sep 2020 10:56:32 +0300 Subject: [PATCH 1/3] Document how to make releases --- README.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.rst b/README.rst index b693b872..cb9b0306 100644 --- a/README.rst +++ b/README.rst @@ -660,4 +660,13 @@ Use bumpversion_ to conveniently change project version:: bumpversion minor # 0.0.1 -> 0.1.0 bumpversion major # 0.1.0 -> 1.0.0 +You can use ``--dry-run --verbose`` flags first to preview changes. + .. _bumpversion: https://pypi.python.org/pypi/bumpversion + +Making releases +--------------- + +* Update ``HISTORY.rst`` in master (via PR or directly) +* use bumpversion (see above) to update the version +* push changes with tags: ``git push --follow-tags`` From 0c1fb13e515fb1808f8115bdac132ef1d71fe30a Mon Sep 17 00:00:00 2001 From: Konstantin Lopuhin Date: Tue, 1 Sep 2020 21:25:59 +0300 Subject: [PATCH 2/3] use a working push sequence the kind of tag created with bumpversion does not get pushed with --follow-tags --- README.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index cb9b0306..6aabecd6 100644 --- a/README.rst +++ b/README.rst @@ -656,9 +656,9 @@ Versioning Use bumpversion_ to conveniently change project version:: - bumpversion patch # 0.0.0 -> 0.0.1 - bumpversion minor # 0.0.1 -> 0.1.0 - bumpversion major # 0.1.0 -> 1.0.0 + bumpversion patch # 0.0.1 -> 0.0.2 + bumpversion minor # 0.1.0 -> 0.2.0 + bumpversion major # 1.0.0 -> 2.0.0 You can use ``--dry-run --verbose`` flags first to preview changes. @@ -668,5 +668,5 @@ Making releases --------------- * Update ``HISTORY.rst`` in master (via PR or directly) -* use bumpversion (see above) to update the version -* push changes with tags: ``git push --follow-tags`` +* use ``bumpversion`` (see above) to update the version +* push changes with tags: ``git push --tags && git push`` From 063e10b1099a1103fe356bdb988d8f7c4561a139 Mon Sep 17 00:00:00 2001 From: Konstantin Lopuhin Date: Wed, 2 Sep 2020 10:39:47 +0300 Subject: [PATCH 3/3] Maintenance stuff moved to wiki --- README.rst | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/README.rst b/README.rst index 6aabecd6..f6d92454 100644 --- a/README.rst +++ b/README.rst @@ -649,24 +649,3 @@ Use tox_ to run tests with different Python versions:: .. _tox: https://testrun.org/tox/latest/ - - -Versioning ----------- - -Use bumpversion_ to conveniently change project version:: - - bumpversion patch # 0.0.1 -> 0.0.2 - bumpversion minor # 0.1.0 -> 0.2.0 - bumpversion major # 1.0.0 -> 2.0.0 - -You can use ``--dry-run --verbose`` flags first to preview changes. - -.. _bumpversion: https://pypi.python.org/pypi/bumpversion - -Making releases ---------------- - -* Update ``HISTORY.rst`` in master (via PR or directly) -* use ``bumpversion`` (see above) to update the version -* push changes with tags: ``git push --tags && git push``