From 923a7e8d68c540e3642800daa4e6761f400937a1 Mon Sep 17 00:00:00 2001 From: Bertrand Dunogier Date: Fri, 22 Jan 2016 10:40:20 +0100 Subject: Added RELEASE_PROCESS document --- RELEASE_PROCESS.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 RELEASE_PROCESS.md diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md new file mode 100644 index 00000000..ebca54d6 --- /dev/null +++ b/RELEASE_PROCESS.md @@ -0,0 +1,37 @@ +## Definition + +A release is mostly a git tag of http://github.com/wallabag/wallabag, following [semantic versioning](http://semver.org). +The last release at the time of writing is 2.0.0-alpha.2, from the v2 branch. + +### Steps +- Update `wallabag.version` is up-to-date in `app/config/config.yml` if necessary +- run composer update to make sure `composer.lock` is up-to-date +- add and update `composer.lock`: `git add -f composer.lock && git commit -m "Added composer.lock for 2.0.0-alpha.3 release"` +- create the tag: `git tag 2.0.0-alpha.3` +- remove composer.lock, and commit: `git rm composer.lock && git commit -m "Removed composer.lock"` +- push the tag: `git push origin 2.0.0-alpha.3` +- go to http://github.com/wallabag/wallabag/releases +- find the tag that was created in the list, click on the tag. Edit the release name / description + +### `composer.lock` +A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done, +making it easier to fix issues after the release. It also speeds up `composer install` on stable versions a LOT, by skipping the +dependencies resolution part. + +Since `composer.lock` is ignored by default, either it must be removed from `.gitignore` _in the release branch_, +or it must be added using `git add --force composer.lock`. + +### Target PHP version +`composer.lock` is _always_ built for a particular version, by default the one it is generated (with `composer update`). + +If the PHP version used to generate the .lock isn't a widely available one (like PHP 7), a more common one should +be locally specified in `composer.lock`: + +```json + "config": { + "platform": { + "php": "5.5.9", + "ext-something": "4.0" + } + } +``` -- cgit v1.2.3 From 461a1714679bf43075fa7c390e37cbc7f11af095 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Tue, 1 Mar 2016 15:39:22 +0100 Subject: Releasing documentation --- docs/en/developer/releasing.rst | 45 +++++++++++++++++++++++++++++++++++++++++ docs/en/index.rst | 1 + 2 files changed, 46 insertions(+) create mode 100644 docs/en/developer/releasing.rst diff --git a/docs/en/developer/releasing.rst b/docs/en/developer/releasing.rst new file mode 100644 index 00000000..3c010a7c --- /dev/null +++ b/docs/en/developer/releasing.rst @@ -0,0 +1,45 @@ +Releasing wallabag +================== + +During this documentation, we assume the release is `release-2.0.0-beta.1`. + +Files to edit +------------- + +- ``app/config/config.yml`` (``wallabag_core.version``) +- ``README.md`` (``composer create-project`` command) +- ``docs/en/user/installation.rst`` and its translations (``composer create-project`` command) + + +Create release on GitHub +------------------------ + +- Run these commands to create the tag: + +:: + + git checkout v2 + git pull origin v2 + git checkout -b release-2.0.0-beta.1 + SYMFONY_ENV=prod composer up --no-dev + git add --force composer.lock + git add README.md + git commit -m "Release wallabag 2.0.0-beta.1" + git push origin release-2.0.0-beta.1 + + +- 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. +- Run these commands to create the package: + +:: + + git clone git@github.com:wallabag/wallabag.git -b release-2.0.0-beta.1 release-2.0.0-beta.1 + SYMFONY_ENV=prod composer up -d=release-2.0.0-beta.1 --no-dev + tar czf wallabag-release-2.0.0-beta.1.tar.gz --exclude="var/*" --exclude=".git" release-2.0.0-beta.1 + + +- `Create the new release on GitHub `__. You have to upload on this page the package. +- Delete the ``release-2.0.0-beta.1`` branch and close the pull request (**DO NOT MERGE IT**). +- Update the URL shortener (used on ``wllbg.org`` to generate links like ``http://wllbg.org/latest-v2-package`` or ``http://wllbg.org/latest-v2``) +- Update `the downloads page `__ on the website (MD5 sum, release date) +- Drink a beer! 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: developer/docker developer/translate developer/maintenance + developer/releasing -- cgit v1.2.3 From 6b6f725182adc9eab807d7a712ed42a972a4d7d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Tue, 1 Mar 2016 20:21:18 +0100 Subject: Add steps in RELEASE_PROCESS --- RELEASE_PROCESS.md | 48 +++++++++++++++++++++++++++++++++-------- docs/en/developer/releasing.rst | 45 -------------------------------------- 2 files changed, 39 insertions(+), 54 deletions(-) delete mode 100644 docs/en/developer/releasing.rst 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 @@ A release is mostly a git tag of http://github.com/wallabag/wallabag, following [semantic versioning](http://semver.org). The last release at the time of writing is 2.0.0-alpha.2, from the v2 branch. -### Steps -- Update `wallabag.version` is up-to-date in `app/config/config.yml` if necessary -- run composer update to make sure `composer.lock` is up-to-date -- add and update `composer.lock`: `git add -f composer.lock && git commit -m "Added composer.lock for 2.0.0-alpha.3 release"` -- create the tag: `git tag 2.0.0-alpha.3` -- remove composer.lock, and commit: `git rm composer.lock && git commit -m "Removed composer.lock"` -- push the tag: `git push origin 2.0.0-alpha.3` -- go to http://github.com/wallabag/wallabag/releases -- find the tag that was created in the list, click on the tag. Edit the release name / description +### Steps to release + +During this documentation, we assume the release is `release-2.0.0-beta.1`. + +#### Files to edit + +- `app/config/config.yml` (`wallabag_core.version`) +- `README.md` (`composer create-project` command) +- `docs/en/user/installation.rst` and its translations (`composer create-project` command) + +#### Create release on GitHub + +- Run these commands to create the tag: + +``` + git checkout v2 + git pull origin v2 + git checkout -b release-2.0.0-beta.1 + SYMFONY_ENV=prod composer up --no-dev + git add --force composer.lock + git add README.md + git commit -m "Release wallabag 2.0.0-beta.1" + git push origin release-2.0.0-beta.1 +``` + +- 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. +- Run these commands to create the package: + +``` + git clone git@github.com:wallabag/wallabag.git -b release-2.0.0-beta.1 release-2.0.0-beta.1 + SYMFONY_ENV=prod composer up -d=release-2.0.0-beta.1 --no-dev + tar czf wallabag-release-2.0.0-beta.1.tar.gz --exclude="var/*" --exclude=".git" release-2.0.0-beta.1 +``` + +- [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package. +- Delete the `release-2.0.0-beta.1` branch and close the pull request (**DO NOT MERGE IT**). +- Update the URL shortener (used on `wllbg.org` to generate links like `http://wllbg.org/latest-v2-package` or `http://wllbg.org/latest-v2`) +- Update [the downloads page](https://github.com/wallabag/wallabag.org/blob/master/content/pages/download.md) on the website (MD5 sum, release date) +- Drink a beer! ### `composer.lock` 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 @@ -Releasing wallabag -================== - -During this documentation, we assume the release is `release-2.0.0-beta.1`. - -Files to edit -------------- - -- ``app/config/config.yml`` (``wallabag_core.version``) -- ``README.md`` (``composer create-project`` command) -- ``docs/en/user/installation.rst`` and its translations (``composer create-project`` command) - - -Create release on GitHub ------------------------- - -- Run these commands to create the tag: - -:: - - git checkout v2 - git pull origin v2 - git checkout -b release-2.0.0-beta.1 - SYMFONY_ENV=prod composer up --no-dev - git add --force composer.lock - git add README.md - git commit -m "Release wallabag 2.0.0-beta.1" - git push origin release-2.0.0-beta.1 - - -- 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. -- Run these commands to create the package: - -:: - - git clone git@github.com:wallabag/wallabag.git -b release-2.0.0-beta.1 release-2.0.0-beta.1 - SYMFONY_ENV=prod composer up -d=release-2.0.0-beta.1 --no-dev - tar czf wallabag-release-2.0.0-beta.1.tar.gz --exclude="var/*" --exclude=".git" release-2.0.0-beta.1 - - -- `Create the new release on GitHub `__. You have to upload on this page the package. -- Delete the ``release-2.0.0-beta.1`` branch and close the pull request (**DO NOT MERGE IT**). -- Update the URL shortener (used on ``wllbg.org`` to generate links like ``http://wllbg.org/latest-v2-package`` or ``http://wllbg.org/latest-v2``) -- Update `the downloads page `__ on the website (MD5 sum, release date) -- Drink a beer! -- cgit v1.2.3