Merge pull request #4438 from wallabag/dependabot/composer/scheb/two-factor-bundle...

[github/wallabag/wallabag.git] / RELEASE_PROCESS.md

diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md
index ebca54d6702d4a059e4ccec4c8ce6337db591e85..881f07710e5c8557f47a9e559f04dae477245af7 100644 (file)
--- a/RELEASE_PROCESS.md
+++ b/RELEASE_PROCESS.md
@@ -1,36 +1,63 @@
 ## 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
-
-### `composer.lock`
-A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done,
-making it easier to fix issues after the release. It also speeds up `composer install` on stable versions a LOT, by skipping the
-dependencies resolution part.
-
-Since `composer.lock` is ignored by default, either it must be removed from `.gitignore` _in the release branch_,
-or it must be added using `git add --force composer.lock`.
+
+### 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
+composer up
+```
+
+- Then continue with these commands:
+
+```
+git add 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 `Release wallabag $LAST_WALLABAG_RELEASE`. This pull request is used to launch builds on Travis-CI.
+- Once PR is green, merge it and delete the branch.
+- Run this 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 `master` branch or any appropriate branch (for instance backports). You have to upload the package (generated previously).
+- Update the URL shortener (used on `wllbg.org` to update 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:!
 
 ### 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 7), a more common one should
+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`:
 
 ```json
     "config": {
         "platform": {
-            "php": "5.5.9",
+            "php": "7.1.3",
             "ext-something": "4.0"
         }
     }