]> git.immae.eu Git - github/wallabag/wallabag.git/blame - RELEASE_PROCESS.md
fix stylelint
[github/wallabag/wallabag.git] / RELEASE_PROCESS.md
CommitLineData
923a7e8d
BD
1## Definition
2
3A release is mostly a git tag of http://github.com/wallabag/wallabag, following [semantic versioning](http://semver.org).
923a7e8d 4
6b6f7251
NL
5### Steps to release
6
7eff4736 7During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE`.
6b6f7251
NL
8
9#### Files to edit
10
11- `app/config/config.yml` (`wallabag_core.version`)
7eff4736 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))
6b6f7251
NL
13
14#### Create release on GitHub
15
16- Run these commands to create the tag:
17
7c122534
NL
18```
19git checkout master
20git pull origin master
21git checkout -b release-$LAST_WALLABAG_RELEASE
22SYMFONY_ENV=prod composer up --no-dev
23git add --force composer.lock
24git commit -m "Release wallabag $LAST_WALLABAG_RELEASE"
25git push origin release-$LAST_WALLABAG_RELEASE
26```
6b6f7251 27
7eff4736 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.
7c122534 29- Run these command to create the package:
6b6f7251 30
7c122534 31```
ed11d7f7 32make release master /tmp wllbg-release prod
7c122534 33```
6b6f7251
NL
34
35- [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package.
7eff4736 36- Delete the `release-$LAST_WALLABAG_RELEASE` branch and close the pull request (**DO NOT MERGE IT**).
6b6f7251
NL
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)
7eff4736
NL
39- Update Dockerfile https://github.com/wallabag/docker (and create a new tag)
40- Update wallabag.org website (downloads, releases and new blog post)
6b1317a6 41- Put the next patch version suffixed with `-dev` in `app/config/config.yml` (`wallabag_core.version`)
7eff4736 42- Drink a :beer:!
923a7e8d
BD
43
44### `composer.lock`
45A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done,
46making it easier to fix issues after the release. It also speeds up `composer install` on stable versions a LOT, by skipping the
47dependencies resolution part.
48
49Since `composer.lock` is ignored by default, either it must be removed from `.gitignore` _in the release branch_,
50or 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
55If the PHP version used to generate the .lock isn't a widely available one (like PHP 7), a more common one should
56be 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```