diff options
-rw-r--r-- | RELEASE_PROCESS.md | 48 | ||||
-rw-r--r-- | docs/en/developer/releasing.rst | 45 |
2 files changed, 39 insertions, 54 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 @@ | |||
3 | A release is mostly a git tag of http://github.com/wallabag/wallabag, following [semantic versioning](http://semver.org). | 3 | A release is mostly a git tag of http://github.com/wallabag/wallabag, following [semantic versioning](http://semver.org). |
4 | The last release at the time of writing is 2.0.0-alpha.2, from the v2 branch. | 4 | The 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 | 8 | During 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` |
17 | A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done, | 47 | A 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/developer/releasing.rst b/docs/en/developer/releasing.rst deleted file mode 100644 index 3c010a7c..00000000 --- a/docs/en/developer/releasing.rst +++ /dev/null | |||
@@ -1,45 +0,0 @@ | |||
1 | Releasing wallabag | ||
2 | ================== | ||
3 | |||
4 | During this documentation, we assume the release is `release-2.0.0-beta.1`. | ||
5 | |||
6 | Files to edit | ||
7 | ------------- | ||
8 | |||
9 | - ``app/config/config.yml`` (``wallabag_core.version``) | ||
10 | - ``README.md`` (``composer create-project`` command) | ||
11 | - ``docs/en/user/installation.rst`` and its translations (``composer create-project`` command) | ||
12 | |||
13 | |||
14 | Create release on GitHub | ||
15 | ------------------------ | ||
16 | |||
17 | - Run these commands to create the tag: | ||
18 | |||
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 ``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 | |||
36 | git clone git@github.com:wallabag/wallabag.git -b release-2.0.0-beta.1 release-2.0.0-beta.1 | ||
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 | |||
40 | |||
41 | - `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**). | ||
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``) | ||
44 | - 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! | ||