X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=RELEASE_PROCESS.md;h=79e3a40e3d26b841e3c3b50b979940fe7bc9685d;hb=5112b3556b5a85c791cac6ec89c19939e0677904;hp=ebca54d6702d4a059e4ccec4c8ce6337db591e85;hpb=f8b835f537c8bec0460f94b960a8d81745f9e9d6;p=github%2Fwallabag%2Fwallabag.git diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md index ebca54d6..79e3a40e 100644 --- a/RELEASE_PROCESS.md +++ b/RELEASE_PROCESS.md @@ -1,17 +1,45 @@ ## 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`. + +#### Files to edit + +- `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)) + +#### Create 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 + git add --force composer.lock + 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 commands to create the package (you need to clone `https://github.com/wallabag/releaser`) : + +``` + cd releaser/ + ./releaser.sh $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) +- Update Dockerfile https://github.com/wallabag/docker (and create a new tag) +- Update wallabag.org website (downloads, releases and new blog post) +- 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,