From 461a1714679bf43075fa7c390e37cbc7f11af095 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Tue, 1 Mar 2016 15:39:22 +0100 Subject: Releasing documentation --- docs/en/developer/releasing.rst | 45 +++++++++++++++++++++++++++++++++++++++++ docs/en/index.rst | 1 + 2 files changed, 46 insertions(+) create mode 100644 docs/en/developer/releasing.rst diff --git a/docs/en/developer/releasing.rst b/docs/en/developer/releasing.rst new file mode 100644 index 00000000..3c010a7c --- /dev/null +++ b/docs/en/developer/releasing.rst @@ -0,0 +1,45 @@ +Releasing wallabag +================== + +During this documentation, we assume the release is `release-2.0.0-beta.1`. + +Files to edit +------------- + +- ``app/config/config.yml`` (``wallabag_core.version``) +- ``README.md`` (``composer create-project`` command) +- ``docs/en/user/installation.rst`` and its translations (``composer create-project`` command) + + +Create release on GitHub +------------------------ + +- Run these commands to create the tag: + +:: + + git checkout v2 + git pull origin v2 + git checkout -b release-2.0.0-beta.1 + SYMFONY_ENV=prod composer up --no-dev + git add --force composer.lock + git add README.md + git commit -m "Release wallabag 2.0.0-beta.1" + git push origin release-2.0.0-beta.1 + + +- Create a new pull request ``DON'T MERGE Release wallabag 2.0.0-beta.1``. This pull request is used to launch builds on Travis-CI. +- Run these commands to create the package: + +:: + + git clone git@github.com:wallabag/wallabag.git -b release-2.0.0-beta.1 release-2.0.0-beta.1 + SYMFONY_ENV=prod composer up -d=release-2.0.0-beta.1 --no-dev + tar czf wallabag-release-2.0.0-beta.1.tar.gz --exclude="var/*" --exclude=".git" release-2.0.0-beta.1 + + +- `Create the new release on GitHub `__. You have to upload on this page the package. +- Delete the ``release-2.0.0-beta.1`` branch and close the pull request (**DO NOT MERGE IT**). +- Update the URL shortener (used on ``wllbg.org`` to generate links like ``http://wllbg.org/latest-v2-package`` or ``http://wllbg.org/latest-v2``) +- Update `the downloads page `__ on the website (MD5 sum, release date) +- Drink a beer! diff --git a/docs/en/index.rst b/docs/en/index.rst index 54d79e0c..3367c8a9 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -44,3 +44,4 @@ The main documentation for this application is organized into a couple sections: developer/docker developer/translate developer/maintenance + developer/releasing -- cgit v1.2.3