aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJocelyn Delalande <jocelyn@crapouillou.net>2018-11-25 21:30:20 +0100
committerJocelyn Delalande <jocelyn@crapouillou.net>2018-11-25 21:30:20 +0100
commitda28658773e3e0139f48c60a4c516ad461d3947d (patch)
treed3a0efd8421d7f42d0cf4d9237e82cdbd252434f
parentd4729880ddfdddca1c0a8278eaea5cc7de8e7c58 (diff)
downloadihatemoney-mirror-da28658773e3e0139f48c60a4c516ad461d3947d.zip
ihatemoney-mirror-da28658773e3e0139f48c60a4c516ad461d3947d.tar.gz
ihatemoney-mirror-da28658773e3e0139f48c60a4c516ad461d3947d.tar.bz2
Document `make release` magic
I am a bit scared to use this magic command each time I have to. That is to reassure future me and future others :-).
-rw-r--r--docs/contributing.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index 836dc08..1944d67 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -152,3 +152,7 @@ Once this is done, use the "release" instruction:
$ make release
And the new version should be published on PyPI.
+
+.. note:: The above command will prompt for version number, handle
+ :file:`CHANGELOG.rst` and :file:`setup.py` updates, package creation,
+ pypi upload. It will prompt you before each step to get your consent.