aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJeremy Benoist <j0k3r@users.noreply.github.com>2016-03-01 20:49:54 +0100
committerJeremy Benoist <j0k3r@users.noreply.github.com>2016-03-01 20:49:54 +0100
commit646df062dfba986f822e5a4579f8f7333d3a8863 (patch)
tree4e6c7ec3c46b7583a2656e530e214fe4ab726361
parentf8b835f537c8bec0460f94b960a8d81745f9e9d6 (diff)
parent6b6f725182adc9eab807d7a712ed42a972a4d7d0 (diff)
downloadwallabag-646df062dfba986f822e5a4579f8f7333d3a8863.tar.gz
wallabag-646df062dfba986f822e5a4579f8f7333d3a8863.tar.zst
wallabag-646df062dfba986f822e5a4579f8f7333d3a8863.zip
Merge pull request #1743 from wallabag/v2-releasing-documentation
Releasing documentation
-rw-r--r--RELEASE_PROCESS.md48
-rw-r--r--docs/en/index.rst1
2 files changed, 40 insertions, 9 deletions
diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md
index ebca54d6..45e60546 100644
--- a/RELEASE_PROCESS.md
+++ b/RELEASE_PROCESS.md
@@ -3,15 +3,45 @@
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. 4The last release at the time of writing is 2.0.0-alpha.2, from the v2 branch.
5 5
6### Steps 6### Steps to release
7- Update `wallabag.version` is up-to-date in `app/config/config.yml` if necessary 7
8- run composer update to make sure `composer.lock` is up-to-date 8During this documentation, we assume the release is `release-2.0.0-beta.1`.
9- add and update `composer.lock`: `git add -f composer.lock && git commit -m "Added composer.lock for 2.0.0-alpha.3 release"` 9
10- create the tag: `git tag 2.0.0-alpha.3` 10#### Files to edit
11- remove composer.lock, and commit: `git rm composer.lock && git commit -m "Removed composer.lock"` 11
12- push the tag: `git push origin 2.0.0-alpha.3` 12- `app/config/config.yml` (`wallabag_core.version`)
13- go to http://github.com/wallabag/wallabag/releases 13- `README.md` (`composer create-project` command)
14- find the tag that was created in the list, click on the tag. Edit the release name / description 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!
15 45
16### `composer.lock` 46### `composer.lock`
17A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done, 47A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done,
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