mirror of
https://github.com/wallabag/wallabag.git
synced 2024-12-24 16:40:30 +00:00
45 lines
1.7 KiB
Markdown
45 lines
1.7 KiB
Markdown
## Definition
|
|
|
|
A release is mostly a git tag of http://github.com/wallabag/wallabag, following [semantic versioning](http://semver.org).
|
|
|
|
### Steps to release
|
|
|
|
During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE` (like 2.3.4).
|
|
|
|
#### Prepare the release
|
|
|
|
- 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.
|
|
|
|
#### Create a new release on GitHub
|
|
|
|
- Run this command to create the package:
|
|
|
|
```
|
|
make release VERSION=$LAST_WALLABAG_RELEASE
|
|
```
|
|
|
|
- [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:!
|
|
|
|
### 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": {
|
|
"php": "7.1.3",
|
|
"ext-something": "4.0"
|
|
}
|
|
}
|
|
```
|