aboutsummaryrefslogtreecommitdiffhomepage
path: root/RELEASE_PROCESS.md
diff options
context:
space:
mode:
authorJeremy Benoist <j0k3r@users.noreply.github.com>2016-10-10 16:58:15 +0200
committerGitHub <noreply@github.com>2016-10-10 16:58:15 +0200
commitbccf7a70bc22171904a5bb82d282e9c956684abc (patch)
treef03a771ac950296aa1a91af363784ec7915eac27 /RELEASE_PROCESS.md
parentc99d90455bf2c3bac8a85cc0fdaf60134ae06cb4 (diff)
parentfa4c39b37c1e1a1b52739a070775e9ba0fafe802 (diff)
downloadwallabag-bccf7a70bc22171904a5bb82d282e9c956684abc.tar.gz
wallabag-bccf7a70bc22171904a5bb82d282e9c956684abc.tar.zst
wallabag-bccf7a70bc22171904a5bb82d282e9c956684abc.zip
Merge pull request #2403 from wallabag/cleanup-install-process-in-doc
Cleaned up documentation for installation process
Diffstat (limited to 'RELEASE_PROCESS.md')
-rw-r--r--RELEASE_PROCESS.md37
1 files changed, 17 insertions, 20 deletions
diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md
index 359bc921..8ac9bbcd 100644
--- a/RELEASE_PROCESS.md
+++ b/RELEASE_PROCESS.md
@@ -1,48 +1,45 @@
1## Definition 1## Definition
2 2
3A release is mostly a git tag of http://github.com/wallabag/wallabag, following [semantic versioning](http://semver.org). 3A release is mostly a git tag of http://github.com/wallabag/wallabag, following [semantic versioning](http://semver.org).
4The last release at the time of writing is 2.0.0-alpha.2, from the v2 branch.
5 4
6### Steps to release 5### Steps to release
7 6
8During this documentation, we assume the release is `release-2.0.0-beta.1`. 7During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE`.
9 8
10#### Files to edit 9#### Files to edit
11 10
12- `app/config/config.yml` (`wallabag_core.version`) 11- `app/config/config.yml` (`wallabag_core.version`)
13- `README.md` (`composer create-project` command) 12- `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))
14- `docs/en/user/installation.rst` and its translations (`composer create-project` command)
15- `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))
16 13
17#### Create release on GitHub 14#### Create release on GitHub
18 15
19- Run these commands to create the tag: 16- Run these commands to create the tag:
20 17
21``` 18```
22 git checkout v2 19git checkout master
23 git pull origin v2 20git pull origin master
24 git checkout -b release-2.0.0-beta.1 21git checkout -b release-$LAST_WALLABAG_RELEASE
25 SYMFONY_ENV=prod composer up --no-dev 22SYMFONY_ENV=prod composer up --no-dev
26 git add --force composer.lock 23git add --force composer.lock
27 git add README.md 24git commit -m "Release wallabag $LAST_WALLABAG_RELEASE"
28 git commit -m "Release wallabag 2.0.0-beta.1" 25git push origin release-$LAST_WALLABAG_RELEASE
29 git push origin release-2.0.0-beta.1
30``` 26```
31 27
32- 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. 28- 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.
33- Run these commands to create the package: 29- Run these command to create the package:
34 30
35``` 31```
36 git clone git@github.com:wallabag/wallabag.git -b release-2.0.0-beta.1 release-2.0.0-beta.1 32make release master /tmp wllbg-release prod
37 SYMFONY_ENV=prod composer up -d=release-2.0.0-beta.1 --no-dev
38 tar czf wallabag-release-2.0.0-beta.1.tar.gz --exclude="var/*" --exclude=".git" release-2.0.0-beta.1
39``` 33```
40 34
41- [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package. 35- [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package.
42- Delete the `release-2.0.0-beta.1` branch and close the pull request (**DO NOT MERGE IT**). 36- Delete the `release-$LAST_WALLABAG_RELEASE` branch and close the pull request (**DO NOT MERGE IT**).
43- Update the URL shortener (used on `wllbg.org` to generate links like `http://wllbg.org/latest-v2-package` or `http://wllbg.org/latest-v2`) 37- Update the URL shortener (used on `wllbg.org` to generate links like `http://wllbg.org/latest-v2-package` or `http://wllbg.org/latest-v2`)
44- Update [the downloads page](https://github.com/wallabag/wallabag.org/blob/master/content/pages/download.md) on the website (MD5 sum, release date) 38- Update [the downloads page](https://github.com/wallabag/wallabag.org/blob/master/content/pages/download.md) on the website (MD5 sum, release date)
45- Drink a beer! 39- Update Dockerfile https://github.com/wallabag/docker (and create a new tag)
40- Update wallabag.org website (downloads, releases and new blog post)
41- Put the next patch version suffixed with `-dev` in `app/config/config.yml` (`wallabag_core.version`)
42- Drink a :beer:!
46 43
47### `composer.lock` 44### `composer.lock`
48A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done, 45A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done,