]> git.immae.eu Git - github/wallabag/wallabag.git/blame_incremental - RELEASE_PROCESS.md
Bump jquery from 2.2.4 to 3.5.0
[github/wallabag/wallabag.git] / RELEASE_PROCESS.md
... / ...
CommitLineData
1## Definition
2
3A release is mostly a git tag of http://github.com/wallabag/wallabag, following [semantic versioning](http://semver.org).
4
5### Steps to release
6
7During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE` (like 2.3.4).
8
9#### Prepare the release
10
11- Update these files with new information
12 - `app/config/wallabag.yml` (`wallabag_core.version`)
13 - `CHANGELOG.md`
14- Create a PR named "Prepare $LAST_WALLABAG_RELEASE release".
15- Wait for test to be ok, merge it.
16
17#### Create a new release on GitHub
18
19- Run these commands to create the tag:
20
21```
22git checkout master
23git pull origin master
24git checkout -b release-$LAST_WALLABAG_RELEASE
25composer up
26```
27
28- Then continue with these commands:
29
30```
31git add composer.lock
32git commit -m "Release wallabag $LAST_WALLABAG_RELEASE"
33git push origin release-$LAST_WALLABAG_RELEASE
34```
35
36- Create a new pull request with this title `Release wallabag $LAST_WALLABAG_RELEASE`. This pull request is used to launch builds on Travis-CI.
37- Once PR is green, merge it and delete the branch.
38- Run this command to create the package:
39
40```
41make release VERSION=$LAST_WALLABAG_RELEASE
42```
43
44- [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new) by targetting the `master` branch or any appropriate branch (for instance backports). You have to upload the package (generated previously).
45- Update the URL shortener (used on `wllbg.org` to update links like `https://wllbg.org/latest-v2-package` or `http://wllbg.org/latest-v2`)
46- Update Dockerfile https://github.com/wallabag/docker (and create a new tag)
47- Update wallabag.org website (downloads, MD5 sum, releases and new blog post)
48- Put the next patch version suffixed with `-dev` in `app/config/wallabag.yml` (`wallabag_core.version`)
49- Drink a :beer:!
50
51### Target PHP version
52`composer.lock` is _always_ built for a particular version, by default the one it is generated (with `composer update`).
53
54If the PHP version used to generate the .lock isn't a widely available one (like PHP 8), a more common one should
55be locally specified in `composer.lock`:
56
57```json
58 "config": {
59 "platform": {
60 "php": "7.1.3",
61 "ext-something": "4.0"
62 }
63 }
64```