]>
Commit | Line | Data |
---|---|---|
923a7e8d BD |
1 | ## Definition |
2 | ||
3 | A release is mostly a git tag of http://github.com/wallabag/wallabag, following [semantic versioning](http://semver.org). | |
923a7e8d | 4 | |
6b6f7251 NL |
5 | ### Steps to release |
6 | ||
a03c4d90 | 7 | During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE` (like 2.3.4). |
6b6f7251 NL |
8 | |
9 | #### Files to edit | |
10 | ||
b4da3ee8 | 11 | - `app/config/wallabag.yml` (`wallabag_core.version`) |
42f4f11e | 12 | - `CHANGELOG.md` |
6b6f7251 NL |
13 | |
14 | #### Create release on GitHub | |
15 | ||
16 | - Run these commands to create the tag: | |
17 | ||
7c122534 NL |
18 | ``` |
19 | git checkout master | |
20 | git pull origin master | |
21 | git checkout -b release-$LAST_WALLABAG_RELEASE | |
22 | SYMFONY_ENV=prod composer up --no-dev | |
45277ad2 JB |
23 | ``` |
24 | ||
25 | - Update `.travis.yml` file and replace the composer line with this one: | |
26 | ||
27 | ```diff | |
28 | script: | |
a03c4d90 JB |
29 | - - travis_wait bash composer install -o --no-interaction --no-progress --prefer-dist |
30 | + - travis_wait bash composer update -o --no-interaction --no-progress --prefer-dist | |
45277ad2 JB |
31 | ``` |
32 | ||
33 | - Then continue with these commands: | |
34 | ||
35 | ``` | |
36 | git add --force composer.lock .travis.yml | |
7c122534 NL |
37 | git commit -m "Release wallabag $LAST_WALLABAG_RELEASE" |
38 | git push origin release-$LAST_WALLABAG_RELEASE | |
39 | ``` | |
6b6f7251 | 40 | |
7eff4736 | 41 | - Create a new pull request with this title `DON'T MERGE Release wallabag $LAST_WALLABAG_RELEASE`. This pull request is used to launch builds on Travis-CI. |
7c122534 | 42 | - Run these command to create the package: |
6b6f7251 | 43 | |
7c122534 | 44 | ``` |
a03c4d90 | 45 | make release VERSION=$LAST_WALLABAG_RELEASE |
7c122534 | 46 | ``` |
6b6f7251 | 47 | |
a03c4d90 JB |
48 | - [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new) by targetting the `release-$LAST_WALLABAG_RELEASE` branch. You have to upload the package (generated previously). |
49 | - Close the previously created pull request (**DO NOT MERGE IT**) and delete the `release-$LAST_WALLABAG_RELEASE` branch. | |
0f26c285 | 50 | - Update the URL shortener (used on `wllbg.org` to generate links like `https://wllbg.org/latest-v2-package` or `http://wllbg.org/latest-v2`) |
7eff4736 | 51 | - Update Dockerfile https://github.com/wallabag/docker (and create a new tag) |
a03c4d90 | 52 | - Update wallabag.org website (downloads, MD5 sum, releases and new blog post) |
6b1317a6 | 53 | - Put the next patch version suffixed with `-dev` in `app/config/config.yml` (`wallabag_core.version`) |
7eff4736 | 54 | - Drink a :beer:! |
923a7e8d BD |
55 | |
56 | ### `composer.lock` | |
57 | A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done, | |
58 | making it easier to fix issues after the release. It also speeds up `composer install` on stable versions a LOT, by skipping the | |
59 | dependencies resolution part. | |
60 | ||
61 | Since `composer.lock` is ignored by default, either it must be removed from `.gitignore` _in the release branch_, | |
62 | or it must be added using `git add --force composer.lock`. | |
63 | ||
64 | ### Target PHP version | |
65 | `composer.lock` is _always_ built for a particular version, by default the one it is generated (with `composer update`). | |
66 | ||
67 | If the PHP version used to generate the .lock isn't a widely available one (like PHP 7), a more common one should | |
68 | be locally specified in `composer.lock`: | |
69 | ||
70 | ```json | |
71 | "config": { | |
72 | "platform": { | |
73 | "php": "5.5.9", | |
74 | "ext-something": "4.0" | |
75 | } | |
76 | } | |
77 | ``` |