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/config.yml` (`wallabag_core.version`)
  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))
  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 git add --force composer.lock
  24 git commit -m "Release wallabag $LAST_WALLABAG_RELEASE"
  25 git push origin release-$LAST_WALLABAG_RELEASE
  26 ```
  27
  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.
  29 - Run these command to create the package:
  30
  31 ```
  32 make release master /tmp wllbg-release prod
  33 ```
  34
  35 - [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package.
  36 - Delete the `release-$LAST_WALLABAG_RELEASE` branch and close the pull request (**DO NOT MERGE IT**).
  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)
  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 - Put the next patch version suffixed with `-dev` in `app/config/config.yml` (`wallabag_core.version`)
  42 - Drink a :beer:!
  43
  44 ### `composer.lock`
  45 A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done,
  46 making it easier to fix issues after the release. It also speeds up `composer install` on stable versions a LOT, by skipping the
  47 dependencies resolution part.
  48
  49 Since `composer.lock` is ignored by default, either it must be removed from `.gitignore` _in the release branch_,
  50 or it must be added using `git add --force composer.lock`.
  51
  52 ### Target PHP version
  53 `composer.lock` is _always_ built for a particular version, by default the one it is generated (with `composer update`).
  54
  55 If the PHP version used to generate the .lock isn't a widely available one (like PHP 7), a more common one should
  56 be locally specified in `composer.lock`:
  57
  58 ```json
  59     "config": {
  60         "platform": {
  61             "php": "5.5.9",
  62             "ext-something": "4.0"
  63         }
  64     }
  65 ```