[PATCH] docs: Add notes for v1.1.0

Stephen Finucane stephen.finucane at intel.com
Mon Feb 15 03:22:21 AEDT 2016

Signed-off-by: Stephen Finucane <stephen.finucane at intel.com>
 CHANGELOG.md      |    8 ++++++++
 UPGRADING.md      |   11 ++++++++++-
 docs/upgrading.md |   33 ++++++++++++++++++++++++++-------
 3 files changed, 44 insertions(+), 8 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 86e5ba3..50dc65b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,12 +11,20 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Python 3 support
 - Web UI overhaul
+- Check feature, which can be used to report the status of tests
+- Automatic delegation of patches based on file path
 - Selenium-based UI tests
 - Auto-delegation of patches based on filenames/paths
 - Automated documentation for the XML-RPC API. This can be found at the
   '/xmlrpc' in most patchwork deployments
+- Vagrant support for developers
 - Assorted cleanup tasks and bug fixes
+### Changed
+- Patches can now be delegated to any patchwork user
+- Significant changes to the documentation
 ## [1.0.0] - 2015-10-26
 ### Added
diff --git a/UPGRADING.md b/UPGRADING.md
index b302716..e199855 100644
--- a/UPGRADING.md
+++ b/UPGRADING.md
@@ -1,5 +1,10 @@
 # Patchwork Upgrade Guide
+## 1.0.0 to 1.1.0
+Version 1.1.0 adds a number of new features, but many of these will require
+little to no changes.
 ## 0.9.0 to 1.0.0
 Version 1.0.0 changes a few admin-visible components of patchwork so
@@ -15,7 +20,11 @@ and re-run the grants script. For example, on postgres:
 We highly suggest you move to Django Migrations as support for Django 1.6
 (and subsequently manual SQL migrations) will be dropped in an upcoming
+release. You can do this using the migrate command:
+    ./manage.py migrate --fake-initial
+**NOTE**: The `--fake-initial` parameter is only required on Django >= 1.8.
 ### Update to the new settings infrastructure
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
+    $ ./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.

More information about the Patchwork mailing list