aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexis Métaireau <alexis@notmyidea.org>2017-03-20 21:46:33 +0100
committerAlexis Métaireau <alexis@notmyidea.org>2017-03-21 15:09:31 +0100
commitcaf7f2b814ced8c7ad2a0bacc4e2715ec77ba344 (patch)
tree85bfc76eca3d09244f4f6bf9cc327a3ef1e76666
parent464f50dfc9e5cf3400cab84d42c0d89a0ff62bc4 (diff)
downloadihatemoney-mirror-caf7f2b814ced8c7ad2a0bacc4e2715ec77ba344.zip
ihatemoney-mirror-caf7f2b814ced8c7ad2a0bacc4e2715ec77ba344.tar.gz
ihatemoney-mirror-caf7f2b814ced8c7ad2a0bacc4e2715ec77ba344.tar.bz2
Update the README with the release process
-rw-r--r--AUTHORS2
-rw-r--r--CONTRIBUTORS (renamed from CONTRIBUTORS.rst)10
-rw-r--r--README.rst30
3 files changed, 35 insertions, 7 deletions
diff --git a/AUTHORS b/AUTHORS
deleted file mode 100644
index 89a2af3..0000000
--- a/AUTHORS
+++ /dev/null
@@ -1,2 +0,0 @@
-The project has been started by Alexis Métaireau and Frédéric Sureau. Friends are
-helping since that in the persons of Arnaud Bos and Quentin Roy.
diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS
index 4272b96..0acc7e8 100644
--- a/CONTRIBUTORS.rst
+++ b/CONTRIBUTORS
@@ -1,3 +1,6 @@
+The project has been started by Alexis Métaireau and Frédéric Sureau. Friends are
+helping since that. Here is the complete list of people who gave a hand:
+
0livd <0livd@users.noreply.github.com>
A.Avenel <avenel.alexandre@gmail.com>
Adam Chainz <adam@adamj.eu>
@@ -7,11 +10,8 @@ Arnaud Bos <arnaud.tlse@gmail.com>
Baptiste Jonglez <git@bitsofnetworks.org>
Berteh <berteh@gmail.com>
Feth AREZKI <feth@tuttu.info>
-fredericsureau <frederic.sureau@gmail.com>
-Frédéric Sureau <fred@milka.(none)>
-JocelynDelalande <JocelynDelalande@users.noreply.github.com>
-Jocelyn Delande <jocelyn@crapouillou.net>
+Frédéric Sureau <fredericsureau@gmail.com>
+Jocelyn Delalande <jocelyn@crapouillou.net>
Mathieu Leplatre <leplatrem@gmail.com>
-Quentin <quentin@dhcp204-157.enst.fr>
Tinmn <royque@gmail.com>
Xavier Mehrenberger <xavier.mehrenberger@gmail.com>
diff --git a/README.rst b/README.rst
index e2efecc..30fd094 100644
--- a/README.rst
+++ b/README.rst
@@ -98,3 +98,33 @@ End-user
You just wanted to have a look at the application and found a bug? Please tell
us and go fill a new issue:
https://github.com/spiral-project/ihatemoney/issues
+
+How to release?
+===============
+
+In order to prepare a new release, we are following the following steps.
+
+The `fullrelease` command comes from `zest.releaser
+<https://pypi.python.org/pypi/zest.releaser>`_.
+
+Install `zest.releaser`:
+
+.. code-block:: bash
+
+ $ pip install "zest.releaser"
+
+- Merge remaining pull requests
+- Update ``CHANGELOG.rst``
+- Update known good versions of dependencies in ``requirements.txt`` with this command (from inside the venv):
+
+.. code-block:: bash
+
+ $ pip freeze | grep -v -- '-e' > requirements.txt
+
+Once this is done, use the "fullrelease" command:
+
+.. code-block:: bash
+
+ $ fullrelease
+
+That's all folks!