aboutsummaryrefslogtreecommitdiffhomepage
path: root/RELEASE_PROCESS.md
diff options
context:
space:
mode:
authorNicolas LÅ“uillet <nicolas@loeuillet.org>2016-10-08 15:10:56 +0200
committerNicolas LÅ“uillet <nicolas@loeuillet.org>2016-10-08 15:10:56 +0200
commit7eff4736a1309ad71a75fa74dc1081a3b2303169 (patch)
treef9cad7366b9d8fb394b4927a754b0acfefef7062 /RELEASE_PROCESS.md
parent32d103f702968b494309adcba77bc6226043c6ce (diff)
downloadwallabag-7eff4736a1309ad71a75fa74dc1081a3b2303169.tar.gz
wallabag-7eff4736a1309ad71a75fa74dc1081a3b2303169.tar.zst
wallabag-7eff4736a1309ad71a75fa74dc1081a3b2303169.zip
Cleaned up documentation for installation process
Diffstat (limited to 'RELEASE_PROCESS.md')
-rw-r--r--RELEASE_PROCESS.md33
1 files changed, 15 insertions, 18 deletions
diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md
index 359bc921..79e3a40e 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 19 git checkout master
23 git pull origin v2 20 git pull origin master
24 git checkout -b release-2.0.0-beta.1 21 git checkout -b release-$LAST_WALLABAG_RELEASE
25 SYMFONY_ENV=prod composer up --no-dev 22 SYMFONY_ENV=prod composer up --no-dev
26 git add --force composer.lock 23 git add --force composer.lock
27 git add README.md 24 git commit -m "Release wallabag $LAST_WALLABAG_RELEASE"
28 git commit -m "Release wallabag 2.0.0-beta.1" 25 git 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 commands to create the package (you need to clone `https://github.com/wallabag/releaser`) :
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 32 cd releaser/
37 SYMFONY_ENV=prod composer up -d=release-2.0.0-beta.1 --no-dev 33 ./releaser.sh $LAST_WALLABAG_RELEASE
38 tar czf wallabag-release-2.0.0-beta.1.tar.gz --exclude="var/*" --exclude=".git" release-2.0.0-beta.1
39``` 34```
40 35
41- [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package. 36- [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**). 37- 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`) 38- 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) 39- 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! 40- Update Dockerfile https://github.com/wallabag/docker (and create a new tag)
41- Update wallabag.org website (downloads, releases and new blog post)
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,