diff options
author | Gareth Rees <gareth@mysociety.org> | 2014-11-05 16:21:31 +0000 |
---|---|---|
committer | Gareth Rees <gareth@mysociety.org> | 2014-11-05 16:21:31 +0000 |
commit | 1a6143c4fe1b969eca90fd7970576c0413c7b4c4 (patch) | |
tree | ed24a4509d87ee1982fe5db7cd4dc250522e909e /docs/running | |
parent | 47e9e966005b108206a49a5e50fae52823a70174 (diff) |
Reorder sections on docs/running/upgrading
The page is about upgrading so put this information first. Its likely
to be referred to more often (each time a re-user upgrades) rather than
once or twice for the versioning scheme.
Diffstat (limited to 'docs/running')
-rw-r--r-- | docs/running/upgrading.md | 32 |
1 files changed, 17 insertions, 15 deletions
diff --git a/docs/running/upgrading.md b/docs/running/upgrading.md index 67a9eeba0..45803c556 100644 --- a/docs/running/upgrading.md +++ b/docs/running/upgrading.md @@ -12,6 +12,23 @@ Upgrading Alaveteli This page describes how to keep your site up-to-date </p> +## How to upgrade the code + +* If you're using Capistrano for deployment, + simply [deploy the code]({{site.baseurl}}docs/installing/deploy/#usage): + set the repo and branch in `deploy.yml` to be the version you want. + We recommend you set this to the explicit tag name (for example, + `0.18`, and not `master`) so there's no risk of you accidentally deploying + a new version before you're aware it's been released. +* otherwise, you can simply upgrade by running `git pull` + +## Run the post-deploy script + +Unless you're [using Capistrano for deployment]({{site.baseurl}}docs/installing/deploy/), +you should always run the script `scripts/rails-post-deploy` after each +deployment. This runs any database migrations for you, plus various other +things that can be automated for deployment. + ## Alaveteli Version Numbers Alaveteli uses a shifted version of [semver](http://semver.org). @@ -47,16 +64,6 @@ other changes ("further action"). For this reason, for anything other than a document **before** doing an upgrade. This way you'll be able to prepare for any other changes that might be needed to make the new code work. -## How to upgrade the code - -* If you're using Capistrano for deployment, - simply [deploy the code]({{site.baseurl}}docs/installing/deploy/#usage): - set the repo and branch in `deploy.yml` to be the version you want. - We recommend you set this to the explicit tag name (for example, - `0.18`, and not `master`) so there's no risk of you accidentally deploying - a new version before you're aware it's been released. -* otherwise, you can simply upgrade by running `git pull` - ## Patches Patch version increases (e.g. 0.1.2.3 → 0.1.2.**4**) should not require any further action on your part. They will be backwards compatible with the current minor release version. @@ -85,9 +92,4 @@ Only major releases may remove existing functionality. You will be warned about Special instructions will accompany series releases. -## Run the post-deploy script -Unless you're [using Capistrano for deployment]({{site.baseurl}}docs/installing/deploy/), -you should always run the script `scripts/rails-post-deploy` after each -deployment. This runs any database migrations for you, plus various other -things that can be automated for deployment. |