diff options
| author | Stephen Finucane <stephen.finucane@intel.com> | 2016-02-14 16:19:35 +0000 |
|---|---|---|
| committer | Stephen Finucane <stephen.finucane@intel.com> | 2016-02-14 16:24:09 +0000 |
| commit | 8d48e8ccf6e21c0ecf1b1a6eaf9fcfd0584902e9 (patch) | |
| tree | 3a7531675d49a2d23c3f57a86a3614dbf928aeb8 /docs | |
| parent | 633a8a73b4d4205b5b79afc15d71e3c0051b55f6 (diff) | |
| download | patchwork-8d48e8ccf6e21c0ecf1b1a6eaf9fcfd0584902e9.tar patchwork-8d48e8ccf6e21c0ecf1b1a6eaf9fcfd0584902e9.tar.gz | |
docs: Add notes for v1.1.0
Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/upgrading.md | 33 |
1 files changed, 26 insertions, 7 deletions
diff --git a/docs/upgrading.md b/docs/upgrading.md index c50e032..5f97950 100644 --- a/docs/upgrading.md +++ b/docs/upgrading.md @@ -40,23 +40,42 @@ versions of a package or may be missing a package altogether (though we try to avoid this). Such changes are usually listed in the `UPGRADING` document, but you can also diff the `requirements.txt` files in each release for comparison. -## Ensure Your Database is Ready +## Collect Static Files + +New versions of patchwork generally contain changes to the additional files +like images, CSS and JavaScript. To do this, run the `collectstatic` +management commands: + + $ ./manage.py collectstatic + +## Upgrade Your Database Migrations of the database can be tricky. Prior to [`v1.0.0`][gh-v1], database migrations were provided by way of manual, SQL migration scripts. After this release, patchwork moved to support [Django migrations][ref-django-migrate]. If you are upgrading from `v1.0.0` or later, it is likely that you can rely -entirely on the later to bring your database up-to-date. However, there are a -number of scenarios in which you may need to fall back to the provided SQL -migrations or provide your own: +entirely on the later to bring your database up-to-date. This can be done like +so: + + $ ./manage.py migrate + +However, there are a number of scenarios in which you may need to fall back to +the provided SQL migrations or provide your own: * You are using Django < 1.6 patchwork supports Django 1.6. However, Django Migrations was added in 1.7 and is [not available for previous versions][ref-south2]. As such, you must - continue to use manual migrations or upgrade your version of Django. + continue to use manual migrations or upgrade your version of Django. For + many of the migrations, this can be done automatically: + + $ ./manage.py sqlmigrate patchwork 0003_add_check_model + + However, this only works for schema migrations. For data migrations, + however, this will fail. In this cases, these migrations will need to be + handwritten. -* You are using Django > 1.6, but upgrading from patchwork < 1.0 +* You are using Django > 1.6, but upgrading from patchwork < 1.0.0 patchwork only started providing migrations in `v1.0.0`. SQL migrations are provided for versions prior to this and must be applied to get the database @@ -94,7 +113,7 @@ a consistent state (remember: **backup**!). Once this is done, you can resume using the upstream-provided migrations, ensuring any Django migrations that you may have skipped are not applied again: - ./manage.py migrate 000x-abc --fake # when 000x-abc is last "skippable" + $ ./manage.py migrate 000x-abc --fake # when 000x-abc is last "skippable" It's worth adding that with the databases now back in sync it should be possible to return to using upstream code rather than maintaining a fork. |