X-Git-Url: https://git.immae.eu/?p=github%2Fwallabag%2Fwallabag.git;a=blobdiff_plain;f=RELEASE_PROCESS.md;h=829f8390cb80c13c78d0e22aaa2188abe8ecda95;hp=359bc921e2e5cae60dce5bc5f338e966ffcdee6d;hb=4fd5f670fe555da54c7a488b2a038a6ee36ee935;hpb=233a1081eaab7bb4a157015c33755a66afbdb922 diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md index 359bc921..829f8390 100644 --- a/RELEASE_PROCESS.md +++ b/RELEASE_PROCESS.md @@ -1,48 +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 to release -During this documentation, we assume the release is `release-2.0.0-beta.1`. +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`) -- `README.md` (`composer create-project` command) -- `docs/en/user/installation.rst` and its translations (`composer create-project` command) -- `CHANGELOG.md` (by using this command `github_changelog_generator --no-compare-link --future-release "2.x.x"`. [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: ``` - git checkout v2 - git pull origin v2 - git checkout -b release-2.0.0-beta.1 - SYMFONY_ENV=prod composer up --no-dev - git add --force composer.lock - git add README.md - git commit -m "Release wallabag 2.0.0-beta.1" - git push origin release-2.0.0-beta.1 +git checkout master +git pull origin master +git checkout -b release-$LAST_WALLABAG_RELEASE +SYMFONY_ENV=prod composer up --no-dev ``` -- Create a new pull request with this title `DON'T MERGE Release wallabag 2.0.0-beta.1`. This pull request is used to launch builds on Travis-CI. -- Run these commands to create the package: +- 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 ``` - git clone git@github.com:wallabag/wallabag.git -b release-2.0.0-beta.1 release-2.0.0-beta.1 - SYMFONY_ENV=prod composer up -d=release-2.0.0-beta.1 --no-dev - tar czf wallabag-release-2.0.0-beta.1.tar.gz --exclude="var/*" --exclude=".git" release-2.0.0-beta.1 + +- 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). You have to upload on this page the package. -- Delete the `release-2.0.0-beta.1` 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) -- Drink a beer! +- [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,