projects / github / wallabag / wallabag.git / blame
| Commit | Line | Data |
|---|---|---|
| 923a7e8d BD |
1 | ## Definition |
| 2 | ||
| 3 | A 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 | ||
| a03c4d90 | 7 | During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE` (like 2.3.4). |
| 6b6f7251 | 8 | |
| a1272ab8 | 9 | #### Prepare the release |
| 6b6f7251 | 10 | |
| a1272ab8 JB |
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. | |
| 6b6f7251 | 16 | |
| a1272ab8 | 17 | #### Create a new release on GitHub |
| 6b6f7251 NL |
18 | |
| 19 | - Run these commands to create the tag: | |
| 20 | ||
| 7c122534 NL |
21 | ``` |
| 22 | git checkout master | |
| 23 | git pull origin master | |
| 24 | git checkout -b release-$LAST_WALLABAG_RELEASE | |
| 6546aca4 | 25 | composer up |
| 45277ad2 JB |
26 | ``` |
| 27 | ||
| 28 | - Then continue with these commands: | |
| 29 | ||
| 30 | ``` | |
| 6546aca4 | 31 | git add composer.lock |
| 7c122534 NL |
32 | git commit -m "Release wallabag $LAST_WALLABAG_RELEASE" |
| 33 | git push origin release-$LAST_WALLABAG_RELEASE | |
| 34 | ``` | |
| 6b6f7251 | 35 | |
| 6546aca4 JB |
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. | |
| 2770b6d7 | 38 | - Run this command to create the package: |
| 6b6f7251 | 39 | |
| 7c122534 | 40 | ``` |
| a03c4d90 | 41 | make release VERSION=$LAST_WALLABAG_RELEASE |
| 7c122534 | 42 | ``` |
| 6b6f7251 | 43 | |
| 2770b6d7 | 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). |
| 6546aca4 | 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`) |
| 7eff4736 | 46 | - Update Dockerfile https://github.com/wallabag/docker (and create a new tag) |
| a03c4d90 | 47 | - Update wallabag.org website (downloads, MD5 sum, releases and new blog post) |
| 4fd5f670 | 48 | - Put the next patch version suffixed with `-dev` in `app/config/wallabag.yml` (`wallabag_core.version`) |
| 7eff4736 | 49 | - Drink a :beer:! |
| 2770b6d7 JB |
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 | ||
| 54 | If the PHP version used to generate the .lock isn't a widely available one (like PHP 8), a more common one should | |
| 55 | be 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 | ``` |