X-Git-Url: https://git.immae.eu/?p=github%2Fwallabag%2Fwallabag.git;a=blobdiff_plain;f=RELEASE_PROCESS.md;h=829f8390cb80c13c78d0e22aaa2188abe8ecda95;hp=ebca54d6702d4a059e4ccec4c8ce6337db591e85;hb=4fd5f670fe555da54c7a488b2a038a6ee36ee935;hpb=f8b835f537c8bec0460f94b960a8d81745f9e9d6 diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md index ebca54d6..829f8390 100644 --- a/RELEASE_PROCESS.md +++ b/RELEASE_PROCESS.md @@ -1,17 +1,60 @@ ## Definition A release is mostly a git tag of http://github.com/wallabag/wallabag, following [semantic versioning](http://semver.org). -The last release at the time of writing is 2.0.0-alpha.2, from the v2 branch. - -### Steps -- Update `wallabag.version` is up-to-date in `app/config/config.yml` if necessary -- run composer update to make sure `composer.lock` is up-to-date -- add and update `composer.lock`: `git add -f composer.lock && git commit -m "Added composer.lock for 2.0.0-alpha.3 release"` -- create the tag: `git tag 2.0.0-alpha.3` -- remove composer.lock, and commit: `git rm composer.lock && git commit -m "Removed composer.lock"` -- push the tag: `git push origin 2.0.0-alpha.3` -- go to http://github.com/wallabag/wallabag/releases -- find the tag that was created in the list, click on the tag. Edit the release name / description + +### 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 these commands to create the tag: + +``` +git checkout master +git pull origin master +git checkout -b release-$LAST_WALLABAG_RELEASE +SYMFONY_ENV=prod composer up --no-dev +``` + +- Update `.travis.yml` file and replace the composer line with this one: + +```diff +script: +- - travis_wait bash composer install -o --no-interaction --no-progress --prefer-dist ++ - travis_wait bash composer update -o --no-interaction --no-progress --prefer-dist +``` + +- Then continue with these commands: + +``` +git add --force composer.lock .travis.yml +git commit -m "Release wallabag $LAST_WALLABAG_RELEASE" +git push origin release-$LAST_WALLABAG_RELEASE +``` + +- Create a new pull request with this title `DON'T MERGE Release wallabag $LAST_WALLABAG_RELEASE`. This pull request is used to launch builds on Travis-CI. +- Run these 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 `release-$LAST_WALLABAG_RELEASE` branch. You have to upload the package (generated previously). +- Close the previously created pull request (**DO NOT MERGE IT**) and delete the `release-$LAST_WALLABAG_RELEASE` branch. +- Update the URL shortener (used on `wllbg.org` to generate links like `https://wllbg.org/latest-v2-package` or `http://wllbg.org/latest-v2`) +- 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:! ### `composer.lock` A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done,