2016-01-22 10:40:20 +01:00
## Definition
A release is mostly a git tag of http://github.com/wallabag/wallabag, following [semantic versioning ](http://semver.org ).
2016-03-01 20:21:18 +01:00
### Steps to release
2018-11-25 09:43:21 +01:00
During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE` (like 2.3.4).
2016-03-01 20:21:18 +01:00
2018-12-14 20:59:16 +01:00
#### Prepare the release
2016-03-01 20:21:18 +01:00
2018-12-14 20:59:16 +01:00
- Update these files with new information
2024-02-20 00:47:53 +01:00
- `app/config/wallabag.yml` (`wallabag.version`)
2018-12-14 20:59:16 +01:00
- `CHANGELOG.md`
- Create a PR named "Prepare $LAST_WALLABAG_RELEASE release".
- Wait for test to be ok, merge it.
2016-03-01 20:21:18 +01:00
2018-12-14 20:59:16 +01:00
#### Create a new release on GitHub
2016-03-01 20:21:18 +01:00
2022-06-09 11:30:14 +02:00
- [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).
2023-07-24 13:48:46 +02:00
- Update [website ](https://github.com/wallabag/website ) to change MD5 sum and create the release blog post (based on the changelog).
2016-10-08 15:10:56 +02:00
- Update Dockerfile https://github.com/wallabag/docker (and create a new tag)
2024-02-20 00:47:53 +01:00
- Put the next patch version suffixed with `-dev` in `app/config/wallabag.yml` (`wallabag.version`)
2016-10-08 15:10:56 +02:00
- Drink a :beer:!
2019-05-29 12:02:24 +02:00
### Target PHP version
`composer.lock` is _always_ built for a particular version, by default the one it is generated (with `composer update` ).
If the PHP version used to generate the .lock isn't a widely available one (like PHP 8), a more common one should
be locally specified in `composer.lock` :
```json
"config": {
"platform": {
2022-05-13 00:54:21 +02:00
"php": "7.4.29",
2019-05-29 12:02:24 +02:00
"ext-something": "4.0"
}
}
```