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 34e9a36f2bd3b241d2fa4e74ac54c870b03b1de6..881f07710e5c8557f47a9e559f04dae477245af7 100644 (file)
--- 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 --header-label="# Changelog" --no-issues --no-pr-wo-labels --since-tag="1.9.2"`. [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:
 
@@ -19,46 +22,42 @@ During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE`.
 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
+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 `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:
+- 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 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 `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, 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`
-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`.
-
 ### 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"
         }
     }