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 - `CHANGELOG.md` (by using this command `github_changelog_generator --no-compare-link --future-release "2.x.x"`. [github-changelog-generator is available here](https://github.com/skywinder/github-changelog-generator))
  16
  17 #### Create release on GitHub
  18
  19 - Run these commands to create the tag:
  20
  21 ```
  22     git checkout v2
  23     git pull origin v2
  24     git checkout -b release-2.0.0-beta.1
  25     SYMFONY_ENV=prod composer up --no-dev
  26     git add --force composer.lock
  27     git add README.md
  28     git commit -m "Release wallabag 2.0.0-beta.1"
  29     git push origin release-2.0.0-beta.1
  30 ```
  31
  32 - 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.
  33 - Run these commands to create the package:
  34
  35 ```
  36     git clone git@github.com:wallabag/wallabag.git -b release-2.0.0-beta.1 release-2.0.0-beta.1
  37     SYMFONY_ENV=prod composer up -d=release-2.0.0-beta.1 --no-dev
  38     tar czf wallabag-release-2.0.0-beta.1.tar.gz --exclude="var/*" --exclude=".git" release-2.0.0-beta.1
  39 ```
  40
  41 - [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package.
  42 - Delete the `release-2.0.0-beta.1` branch and close the pull request (**DO NOT MERGE IT**).
  43 - Update the URL shortener (used on `wllbg.org` to generate links like `http://wllbg.org/latest-v2-package` or `http://wllbg.org/latest-v2`)
  44 - Update [the downloads page](https://github.com/wallabag/wallabag.org/blob/master/content/pages/download.md) on the website (MD5 sum, release date)
  45 - Drink a beer!
  46
  47 ### `composer.lock`
  48 A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done,
  49 making it easier to fix issues after the release. It also speeds up `composer install` on stable versions a LOT, by skipping the
  50 dependencies resolution part.
  51
  52 Since `composer.lock` is ignored by default, either it must be removed from `.gitignore` _in the release branch_,
  53 or it must be added using `git add --force composer.lock`.
  54
  55 ### Target PHP version
  56 `composer.lock` is _always_ built for a particular version, by default the one it is generated (with `composer update`).
  57
  58 If the PHP version used to generate the .lock isn't a widely available one (like PHP 7), a more common one should
  59 be locally specified in `composer.lock`:
  60
  61 ```json
  62     "config": {
  63         "platform": {
  64             "php": "5.5.9",
  65             "ext-something": "4.0"
  66         }
  67     }
  68 ```