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 The last release at the time of writing is 2.0.0-alpha.2, from the v2 branch.
   5
   6 ### Steps to release
   7
   8 During this documentation, we assume the release is `release-2.0.0-beta.1`.
   9
  10 #### Files to edit
  11
  12 - `app/config/config.yml` (`wallabag_core.version`)
  13 - `README.md` (`composer create-project` command)
  14 - `docs/en/user/installation.rst` and its translations (`composer create-project` command)
  15
  16 #### Create release on GitHub
  17
  18 - Run these commands to create the tag:
  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 with this title `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     git clone git@github.com:wallabag/wallabag.git -b release-2.0.0-beta.1 release-2.0.0-beta.1
  36     SYMFONY_ENV=prod composer up -d=release-2.0.0-beta.1 --no-dev
  37     tar czf wallabag-release-2.0.0-beta.1.tar.gz --exclude="var/*" --exclude=".git" release-2.0.0-beta.1
  38 ```
  39
  40 - [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package.
  41 - Delete the `release-2.0.0-beta.1` branch and close the pull request (**DO NOT MERGE IT**).
  42 - Update the URL shortener (used on `wllbg.org` to generate links like `http://wllbg.org/latest-v2-package` or `http://wllbg.org/latest-v2`)
  43 - Update [the downloads page](https://github.com/wallabag/wallabag.org/blob/master/content/pages/download.md) on the website (MD5 sum, release date)
  44 - Drink a beer!
  45
  46 ### `composer.lock`
  47 A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done,
  48 making it easier to fix issues after the release. It also speeds up `composer install` on stable versions a LOT, by skipping the
  49 dependencies resolution part.
  50
  51 Since `composer.lock` is ignored by default, either it must be removed from `.gitignore` _in the release branch_,
  52 or it must be added using `git add --force composer.lock`.
  53
  54 ### Target PHP version
  55 `composer.lock` is _always_ built for a particular version, by default the one it is generated (with `composer update`).
  56
  57 If the PHP version used to generate the .lock isn't a widely available one (like PHP 7), a more common one should
  58 be locally specified in `composer.lock`:
  59
  60 ```json
  61     "config": {
  62         "platform": {
  63             "php": "5.5.9",
  64             "ext-something": "4.0"
  65         }
  66     }
  67 ```