RELEASE_PROCESS.md

   1 ## Definition
   2
   3 A release is mostly a git tag of http://github.com/wallabag/wallabag, following [semantic versioning](http://semver.org).
   4
   5 ### Steps to release
   6
   7 During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE`.
   8
   9 #### Files to edit
  10
  11 - `app/config/wallabag.yml` (`wallabag_core.version`)
  12 - `CHANGELOG.md` (by using this command `github-changes -o wallabag -r wallabag -k YOURGITHUBTOKEN --only-pulls --use-commit-body --title Changelog --date-format YYYY/MM/DD --between-tags 2.0.0-alpha.0...master -n 2.1.3`. [github-changes is available here](https://github.com/lalitkapoor/github-changes))
  13
  14 #### Create release on GitHub
  15
  16 - Run these commands to create the tag:
  17
  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 ```
  24
  25 - Update `.travis.yml` file and replace the composer line with this one:
  26
  27 ```diff
  28 script:
  29 -    - travis_wait bash composer install -o  --no-interaction --no-progress --prefer-dist
  30 +    - travis_wait composer update --no-interaction --no-progress
  31 ```
  32
  33 - Then continue with these commands:
  34
  35 ```
  36 git add --force composer.lock .travis.yml
  37 git commit -m "Release wallabag $LAST_WALLABAG_RELEASE"
  38 git push origin release-$LAST_WALLABAG_RELEASE
  39 ```
  40
  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.
  42 - Run these command to create the package:
  43
  44 ```
  45 make release master /tmp wllbg-release prod
  46 ```
  47
  48 - [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package.
  49 - Delete the `release-$LAST_WALLABAG_RELEASE` branch and close the pull request (**DO NOT MERGE IT**).
  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`)
  51 - Update [the downloads page](https://github.com/wallabag/wallabag.org/blob/master/content/pages/download.md) on the website (MD5 sum, release date)
  52 - Update Dockerfile https://github.com/wallabag/docker (and create a new tag)
  53 - Update wallabag.org website (downloads, releases and new blog post)
  54 - Put the next patch version suffixed with `-dev` in `app/config/config.yml` (`wallabag_core.version`)
  55 - Drink a :beer:!
  56
  57 ### `composer.lock`
  58 A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done,
  59 making it easier to fix issues after the release. It also speeds up `composer install` on stable versions a LOT, by skipping the
  60 dependencies resolution part.
  61
  62 Since `composer.lock` is ignored by default, either it must be removed from `.gitignore` _in the release branch_,
  63 or it must be added using `git add --force composer.lock`.
  64
  65 ### Target PHP version
  66 `composer.lock` is _always_ built for a particular version, by default the one it is generated (with `composer update`).
  67
  68 If the PHP version used to generate the .lock isn't a widely available one (like PHP 7), a more common one should
  69 be locally specified in `composer.lock`:
  70
  71 ```json
  72     "config": {
  73         "platform": {
  74             "php": "5.5.9",
  75             "ext-something": "4.0"
  76         }
  77     }
  78 ```