wallabag/RELEASE_PROCESS.md

46 lines
1.7 KiB
Markdown
Raw Normal View History

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
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
- `app/config/wallabag.yml` (`wallabag_core.version`)
- `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
2019-05-29 12:02:24 +02:00
- Run this command to create the package:
2016-03-01 20:21:18 +01:00
2016-10-10 10:20:32 +02:00
```
make release VERSION=$LAST_WALLABAG_RELEASE
2016-10-10 10:20:32 +02:00
```
2016-03-01 20:21:18 +01:00
2019-05-29 12:02:24 +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). You have to upload the package (generated previously).
- Update nginx config to change the redirect rule for `https://wllbg.org/latest-v2-package` & `http://wllbg.org/latest-v2` (they both redirect to the asset of the GitHub release)
- Update Dockerfile https://github.com/wallabag/docker (and create a new tag)
- Update wallabag.org website (downloads, MD5 sum, releases and new blog post)
- Put the next patch version suffixed with `-dev` in `app/config/wallabag.yml` (`wallabag_core.version`)
- 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"
}
}
```