3 A release is mostly a git tag of http://github.com/wallabag/wallabag, following [semantic versioning](http://semver.org).
7 During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE` (like 2.3.4).
9 #### Prepare the release
11 - Update these files with new information
12 - `app/config/wallabag.yml` (`wallabag_core.version`)
14 - Create a PR named "Prepare $LAST_WALLABAG_RELEASE release".
15 - Wait for test to be ok, merge it.
17 #### Create a new release on GitHub
19 - Run these commands to create the tag:
23 git pull origin master
24 git checkout -b release-$LAST_WALLABAG_RELEASE
25 SYMFONY_ENV=prod composer up --no-dev
28 - Update `.travis.yml` file and replace the composer line with this one:
32 - - travis_wait bash composer install -o --no-interaction --no-progress --prefer-dist
33 + - travis_wait bash composer update -o --no-interaction --no-progress --prefer-dist
36 - Then continue with these commands:
39 git add --force composer.lock .travis.yml
40 git commit -m "Release wallabag $LAST_WALLABAG_RELEASE"
41 git push origin release-$LAST_WALLABAG_RELEASE
44 - 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.
45 - Run these command to create the package:
48 make release VERSION=$LAST_WALLABAG_RELEASE
51 - [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).
52 - Close the previously created pull request (**DO NOT MERGE IT**) and delete the `release-$LAST_WALLABAG_RELEASE` branch.
53 - Update the URL shortener (used on `wllbg.org` to generate links like `https://wllbg.org/latest-v2-package` or `http://wllbg.org/latest-v2`)
54 - Update Dockerfile https://github.com/wallabag/docker (and create a new tag)
55 - Update wallabag.org website (downloads, MD5 sum, releases and new blog post)
56 - Put the next patch version suffixed with `-dev` in `app/config/wallabag.yml` (`wallabag_core.version`)
60 A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done,
61 making it easier to fix issues after the release. It also speeds up `composer install` on stable versions a LOT, by skipping the
62 dependencies resolution part.
64 Since `composer.lock` is ignored by default, either it must be removed from `.gitignore` _in the release branch_,
65 or it must be added using `git add --force composer.lock`.
67 ### Target PHP version
68 `composer.lock` is _always_ built for a particular version, by default the one it is generated (with `composer update`).
70 If the PHP version used to generate the .lock isn't a widely available one (like PHP 7), a more common one should
71 be locally specified in `composer.lock`:
77 "ext-something": "4.0"