aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJuanjo Benages <juanjo@benages.eu>2016-03-01 21:02:13 +0100
committerJuanjo Benages <juanjo@benages.eu>2016-03-01 21:02:13 +0100
commit9c5cfd2823d2f7ed272245e3bab55c33d92dccfd (patch)
tree8569d3842d3bac09970bce95027361592b014cca
parent0e576d21633ef86b85bf5e9f72af96f5fd8a9e7f (diff)
parent646df062dfba986f822e5a4579f8f7333d3a8863 (diff)
downloadwallabag-9c5cfd2823d2f7ed272245e3bab55c33d92dccfd.tar.gz
wallabag-9c5cfd2823d2f7ed272245e3bab55c33d92dccfd.tar.zst
wallabag-9c5cfd2823d2f7ed272245e3bab55c33d92dccfd.zip
Merge remote-tracking branch 'upstream/v2' into v2
-rw-r--r--RELEASE_PROCESS.md67
-rw-r--r--docs/en/index.rst1
2 files changed, 68 insertions, 0 deletions
diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md
new file mode 100644
index 00000000..45e60546
--- /dev/null
+++ b/RELEASE_PROCESS.md
@@ -0,0 +1,67 @@
1## Definition
2
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
6### Steps to release
7
8During this documentation, we assume the release is `release-2.0.0-beta.1`.
9
10#### Files to edit
11
12- `app/config/config.yml` (`wallabag_core.version`)
13- `README.md` (`composer create-project` command)
14- `docs/en/user/installation.rst` and its translations (`composer create-project` command)
15
16#### Create release on GitHub
17
18- Run these commands to create the tag:
19
20```
21 git checkout v2
22 git pull origin v2
23 git checkout -b release-2.0.0-beta.1
24 SYMFONY_ENV=prod composer up --no-dev
25 git add --force composer.lock
26 git add README.md
27 git commit -m "Release wallabag 2.0.0-beta.1"
28 git push origin release-2.0.0-beta.1
29```
30
31- 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.
32- Run these commands to create the package:
33
34```
35 git clone git@github.com:wallabag/wallabag.git -b release-2.0.0-beta.1 release-2.0.0-beta.1
36 SYMFONY_ENV=prod composer up -d=release-2.0.0-beta.1 --no-dev
37 tar czf wallabag-release-2.0.0-beta.1.tar.gz --exclude="var/*" --exclude=".git" release-2.0.0-beta.1
38```
39
40- [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package.
41- Delete the `release-2.0.0-beta.1` branch and close the pull request (**DO NOT MERGE IT**).
42- Update the URL shortener (used on `wllbg.org` to generate links like `http://wllbg.org/latest-v2-package` or `http://wllbg.org/latest-v2`)
43- Update [the downloads page](https://github.com/wallabag/wallabag.org/blob/master/content/pages/download.md) on the website (MD5 sum, release date)
44- Drink a beer!
45
46### `composer.lock`
47A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done,
48making it easier to fix issues after the release. It also speeds up `composer install` on stable versions a LOT, by skipping the
49dependencies resolution part.
50
51Since `composer.lock` is ignored by default, either it must be removed from `.gitignore` _in the release branch_,
52or it must be added using `git add --force composer.lock`.
53
54### Target PHP version
55`composer.lock` is _always_ built for a particular version, by default the one it is generated (with `composer update`).
56
57If the PHP version used to generate the .lock isn't a widely available one (like PHP 7), a more common one should
58be locally specified in `composer.lock`:
59
60```json
61 "config": {
62 "platform": {
63 "php": "5.5.9",
64 "ext-something": "4.0"
65 }
66 }
67```
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 54d79e0c..3367c8a9 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -44,3 +44,4 @@ The main documentation for this application is organized into a couple sections:
44 developer/docker 44 developer/docker
45 developer/translate 45 developer/translate
46 developer/maintenance 46 developer/maintenance
47 developer/releasing