X-Git-Url: https://git.immae.eu/?p=github%2Fwallabag%2Fwallabag.git;a=blobdiff_plain;f=RELEASE_PROCESS.md;h=829f8390cb80c13c78d0e22aaa2188abe8ecda95;hp=8ac9bbcde7bf49a824417fa589cb7701b02ef283;hb=4fd5f670fe555da54c7a488b2a038a6ee36ee935;hpb=bccf7a70bc22171904a5bb82d282e9c956684abc diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md index 8ac9bbcd..829f8390 100644 --- a/RELEASE_PROCESS.md +++ b/RELEASE_PROCESS.md @@ -4,14 +4,17 @@ A release is mostly a git tag of http://github.com/wallabag/wallabag, following ### Steps to release -During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE`. +During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE` (like 2.3.4). -#### Files to edit +#### Prepare the release -- `app/config/config.yml` (`wallabag_core.version`) -- `CHANGELOG.md` (by using this command `github_changelog_generator --no-compare-link`. [github-changelog-generator is available here](https://github.com/skywinder/github-changelog-generator)) +- 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 release on GitHub +#### Create a new release on GitHub - Run these commands to create the tag: @@ -20,7 +23,20 @@ git checkout master git pull origin master git checkout -b release-$LAST_WALLABAG_RELEASE SYMFONY_ENV=prod composer up --no-dev -git add --force composer.lock +``` + +- 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 ``` @@ -29,16 +45,15 @@ git push origin release-$LAST_WALLABAG_RELEASE - Run these command to create the package: ``` -make release master /tmp wllbg-release prod +make release VERSION=$LAST_WALLABAG_RELEASE ``` -- [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package. -- Delete the `release-$LAST_WALLABAG_RELEASE` branch and close the pull request (**DO NOT MERGE IT**). -- Update the URL shortener (used on `wllbg.org` to generate links like `http://wllbg.org/latest-v2-package` or `http://wllbg.org/latest-v2`) -- Update [the downloads page](https://github.com/wallabag/wallabag.org/blob/master/content/pages/download.md) on the website (MD5 sum, release date) +- [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, releases and new blog post) -- Put the next patch version suffixed with `-dev` in `app/config/config.yml` (`wallabag_core.version`) +- 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`