]>
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 | ||
7eff4736 | 7 | During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE`. |
6b6f7251 NL |
8 | |
9 | #### Files to edit | |
10 | ||
11 | - `app/config/config.yml` (`wallabag_core.version`) | |
7eff4736 | 12 | - `CHANGELOG.md` (by using this command `github_changelog_generator --no-compare-link`. [github-changelog-generator is available here](https://github.com/skywinder/github-changelog-generator)) |
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 | |
23 | git add --force composer.lock | |
24 | git commit -m "Release wallabag $LAST_WALLABAG_RELEASE" | |
25 | git push origin release-$LAST_WALLABAG_RELEASE | |
26 | ``` | |
6b6f7251 | 27 | |
7eff4736 | 28 | - 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 | 29 | - Run these command to create the package: |
6b6f7251 | 30 | |
7c122534 NL |
31 | ``` |
32 | make releas emaster /tmp wllbg-release prod | |
33 | ``` | |
6b6f7251 NL |
34 | |
35 | - [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package. | |
7eff4736 | 36 | - Delete the `release-$LAST_WALLABAG_RELEASE` branch and close the pull request (**DO NOT MERGE IT**). |
6b6f7251 NL |
37 | - Update the URL shortener (used on `wllbg.org` to generate links like `http://wllbg.org/latest-v2-package` or `http://wllbg.org/latest-v2`) |
38 | - Update [the downloads page](https://github.com/wallabag/wallabag.org/blob/master/content/pages/download.md) on the website (MD5 sum, release date) | |
7eff4736 NL |
39 | - Update Dockerfile https://github.com/wallabag/docker (and create a new tag) |
40 | - Update wallabag.org website (downloads, releases and new blog post) | |
41 | - Drink a :beer:! | |
923a7e8d BD |
42 | |
43 | ### `composer.lock` | |
44 | A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done, | |
45 | making it easier to fix issues after the release. It also speeds up `composer install` on stable versions a LOT, by skipping the | |
46 | dependencies resolution part. | |
47 | ||
48 | Since `composer.lock` is ignored by default, either it must be removed from `.gitignore` _in the release branch_, | |
49 | or it must be added using `git add --force composer.lock`. | |
50 | ||
51 | ### Target PHP version | |
52 | `composer.lock` is _always_ built for a particular version, by default the one it is generated (with `composer update`). | |
53 | ||
54 | If the PHP version used to generate the .lock isn't a widely available one (like PHP 7), a more common one should | |
55 | be locally specified in `composer.lock`: | |
56 | ||
57 | ```json | |
58 | "config": { | |
59 | "platform": { | |
60 | "php": "5.5.9", | |
61 | "ext-something": "4.0" | |
62 | } | |
63 | } | |
64 | ``` |