From caf7f2b814ced8c7ad2a0bacc4e2715ec77ba344 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexis=20M=C3=A9taireau?= Date: Mon, 20 Mar 2017 21:46:33 +0100 Subject: Update the README with the release process --- AUTHORS | 2 -- CONTRIBUTORS | 17 +++++++++++++++++ CONTRIBUTORS.rst | 17 ----------------- README.rst | 30 ++++++++++++++++++++++++++++++ 4 files changed, 47 insertions(+), 19 deletions(-) delete mode 100644 AUTHORS create mode 100644 CONTRIBUTORS delete mode 100644 CONTRIBUTORS.rst 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 b/CONTRIBUTORS new file mode 100644 index 0000000..0acc7e8 --- /dev/null +++ b/CONTRIBUTORS @@ -0,0 +1,17 @@ +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 +Adam Chainz +Adrien CLERC +Alexis Metaireau +Arnaud Bos +Baptiste Jonglez +Berteh +Feth AREZKI +Frédéric Sureau +Jocelyn Delalande +Mathieu Leplatre +Tinmn +Xavier Mehrenberger diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst deleted file mode 100644 index 4272b96..0000000 --- a/CONTRIBUTORS.rst +++ /dev/null @@ -1,17 +0,0 @@ -0livd <0livd@users.noreply.github.com> -A.Avenel -Adam Chainz -Adrien CLERC -Alexis Metaireau -Arnaud Bos -Baptiste Jonglez -Berteh -Feth AREZKI -fredericsureau -Frédéric Sureau -JocelynDelalande -Jocelyn Delande -Mathieu Leplatre -Quentin -Tinmn -Xavier Mehrenberger 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 +`_. + +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! -- cgit v1.1