]> git.immae.eu Git - github/wallabag/wallabag.git/blob - docs/en/developer/releasing.rst
Releasing documentation
[github/wallabag/wallabag.git] / docs / en / developer / releasing.rst
1 Releasing wallabag
2 ==================
3
4 During this documentation, we assume the release is `release-2.0.0-beta.1`.
5
6 Files to edit
7 -------------
8
9 - ``app/config/config.yml`` (``wallabag_core.version``)
10 - ``README.md`` (``composer create-project`` command)
11 - ``docs/en/user/installation.rst`` and its translations (``composer create-project`` command)
12
13
14 Create release on GitHub
15 ------------------------
16
17 - Run these commands to create the tag:
18
19 ::
20
21 git checkout v2
22 git pull origin v2
23 git checkout -b release-2.0.0-beta.1
24 SYMFONY_ENV=prod composer up --no-dev
25 git add --force composer.lock
26 git add README.md
27 git commit -m "Release wallabag 2.0.0-beta.1"
28 git push origin release-2.0.0-beta.1
29
30
31 - 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.
32 - Run these commands to create the package:
33
34 ::
35
36 git clone git@github.com:wallabag/wallabag.git -b release-2.0.0-beta.1 release-2.0.0-beta.1
37 SYMFONY_ENV=prod composer up -d=release-2.0.0-beta.1 --no-dev
38 tar czf wallabag-release-2.0.0-beta.1.tar.gz --exclude="var/*" --exclude=".git" release-2.0.0-beta.1
39
40
41 - `Create the new release on GitHub <https://github.com/wallabag/wallabag/releases/new>`__. You have to upload on this page the package.
42 - Delete the ``release-2.0.0-beta.1`` branch and close the pull request (**DO NOT MERGE IT**).
43 - Update the URL shortener (used on ``wllbg.org`` to generate links like ``http://wllbg.org/latest-v2-package`` or ``http://wllbg.org/latest-v2``)
44 - Update `the downloads page <https://github.com/wallabag/wallabag.org/blob/master/content/pages/download.md>`__ on the website (MD5 sum, release date)
45 - Drink a beer!