diff options
| author | Gareth Rees <gareth@mysociety.org> | 2014-10-15 16:43:24 +0100 |
|---|---|---|
| committer | Gareth Rees <gareth@mysociety.org> | 2014-10-15 16:43:24 +0100 |
| commit | 87a5b58e01452ab41b4db31367020dafe56f8c1d (patch) | |
| tree | cb921c7eaf620c5640fc500f0d481861219afb6a | |
| parent | 9e6f73cdd70d7c0db8f72d5d7f69f391a3472498 (diff) | |
Major release upgrade and compatibility
| -rw-r--r-- | docs/running/upgrading.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/running/upgrading.md b/docs/running/upgrading.md index 93f459793..33b2f55c5 100644 --- a/docs/running/upgrading.md +++ b/docs/running/upgrading.md @@ -75,6 +75,12 @@ from Transifex and save it in the `locale/` folder. Minor releases will be backwards compatible with the current major release version. +## Major releases + +Major version increases (e.g. 0.1.2.4 → 0.2.0.0) will usually require further action. You should read the [`CHANGES.md`](https://github.com/mysociety/alaveteli/blob/master/doc/CHANGES.md) document to see what's changed since your last deployment, paying special attention to anything in the "Upgrade notes" sections. + +Only major releases may remove existing functionality. You will be warned about the removal of functionality with a deprecation notice in a minor release prior to the major release that removes the functionality. + ## Run the post-deploy script Unless you're [using Capistrano for deployment]({{site.baseurl}}docs/installing/deploy/), |