wallabag/RELEASE_PROCESS.md
2024-02-23 07:42:48 +01:00

1.4 KiB

Definition

A release is mostly a git tag of http://github.com/wallabag/wallabag, following semantic versioning.

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.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

  • Create the new release on GitHub by targetting the master branch or any appropriate branch (for instance backports).
  • Update website to change MD5 sum and create the release blog post (based on the changelog).
  • Update Dockerfile https://github.com/wallabag/docker (and create a new tag)
  • Put the next patch version suffixed with -dev in app/config/wallabag.yml (wallabag.version)
  • Drink a 🍺!

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:

    "config": {
        "platform": {
            "php": "7.4.29",
            "ext-something": "4.0"
        }
    }