aboutsummaryrefslogtreecommitdiff
path: root/docs/releases
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2017-03-22 23:03:00 +0000
committerStephen Finucane <stephen@that.guru>2017-04-18 22:08:32 +0100
commitbc2f6162acd5cbf9b16959fb28b726ba12d49767 (patch)
tree1ab85af801dc82d8031c1f49e8a84ad5d9bb9efd /docs/releases
parent3031c9d5647870aff7dae812368add11421a626e (diff)
downloadpatchwork-bc2f6162acd5cbf9b16959fb28b726ba12d49767.tar
patchwork-bc2f6162acd5cbf9b16959fb28b726ba12d49767.tar.gz
docs: Migrate release notes to rST
This allows us to remove both UPGRADING and CHANGELOG. Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'docs/releases')
-rw-r--r--docs/releases/alpaca.rst10
-rw-r--r--docs/releases/burlap.rst99
-rw-r--r--docs/releases/cashmere.rst82
-rw-r--r--docs/releases/unreleased.rst1
4 files changed, 191 insertions, 1 deletions
diff --git a/docs/releases/alpaca.rst b/docs/releases/alpaca.rst
new file mode 100644
index 0000000..e4b310d
--- /dev/null
+++ b/docs/releases/alpaca.rst
@@ -0,0 +1,10 @@
+v0.9 Series ("Alpaca")
+======================
+
+This represents the state of the Patchwork code before adopting `semantic
+versioning`__, along with `fabric-inspired release names`__. For information on
+the features available in this release, refer to the `git logs`__.
+
+__ http://semver.org/
+__ https://en.wikipedia.org/wiki/List_of_fabrics
+__ https://github.com/getpatchwork/patchwork/commits/v0.9.0
diff --git a/docs/releases/burlap.rst b/docs/releases/burlap.rst
new file mode 100644
index 0000000..8477e88
--- /dev/null
+++ b/docs/releases/burlap.rst
@@ -0,0 +1,99 @@
+v1.0 Series ("Burlap")
+======================
+
+1.0.0
+-----
+
+This release changes a few admin-visible components of Patchwork, so upgrading
+involves a few steps.
+
+New Features
+~~~~~~~~~~~~
+
+- Patch tags are now supported
+
+ Patch "tags", such as `Acked-by`, `Reviewed-by`, are typically included in
+ patches and replies. They provide important information as to the activity
+ and "mergability" of a patch. These tags are now extracted from patches and
+ included in the patch list.
+
+- Django 1.7 and Django 1.8 are now supported
+
+- tox support is integrated for use by developers
+
+Upgrade Notes
+~~~~~~~~~~~~~
+
+- Migrations are now executed using the Django migrations framework.
+
+ Future database migrations will be implemented using Django Migrations,
+ rather than raw SQL scripts. Before switching to Django migrations, first
+ apply any unapplied migrations in the `lib/sql/migration` folder. For
+ example, on postgres::
+
+ $ psql -f lib/sql/migration/015-add-patch-tags.sql patchwork
+ $ psql -f lib/sql/grant-all.postgres.sql patchwork
+
+ Once applied, configure the required Django Migration tables using the
+ `migrate` managment command::
+
+ $ ./manage.py migrate --fake-initial
+
+- Moved Patchwork source from the `apps` directory to the top level directory.
+
+ Any scripts or tools that call Patchwork applications, such as
+ `parsemail.sh`, must be updated to reference the new location of these
+ scripts. To do this, simply remove `apps/` from the path, i.e.
+ `apps/patchwork/` becomes `patchwork`.
+
+- The `patchwork-cron.py` script has been replaced by the `cron` management
+ command.
+
+ Any references to the former should be updated to the latter. The `cron`
+ management command can be called like so::
+
+ $ ./manage.py cron
+
+- The `settings.py` file has been updated to reflect modern Django practices.
+
+ You may need to manually migrate your existing configuration to the new
+ settings file(s). By default, settings are read from
+ `patchwork/settings/production.py`. To migrate, use the provided template::
+
+ $ cp patchwork/settings/production{.example,}.py
+
+ Merge your previous settings, usually located in `apps/local_settings.py`, to
+ this file.
+
+ In addition, any scripts that set the `DJANGO_SETTINGS_MODULE` environment
+ variable will need to be updated to reflect the new location, typically::
+
+ DJANGO_SETTINGS_MODULE=patchwork.settings.production
+
+- Django `staticfiles` is now used to to gather static files for for serving
+ via a web server
+
+ Static content should now be located in the folder indicated by
+ `STATIC_ROOT`. This should point to somewhere sensible, such as the absolute
+ path of `htdocs/static` in the Patchwork tree. Configure the `STATIC_ROOT`
+ setting in your settings file, then run the `collectstatic` management
+ command::
+
+ $ ./manage.py collectstatic
+
+ Finally, update your webserver configuration to serve the static content from
+ this new location. Refer to the sample web configuration files provided in
+ `lib` for more information.
+
+- Django 1.5 is no longer supported
+
+- Python 2.5 support was broken and is officially no longer supported
+
+Deprecation Notes
+~~~~~~~~~~~~~~~~~
+
+- Django 1.6 support will be removed in a future release
+
+- Raw SQL migration scripts, currently found at `lib/sql/migration`, will no
+ longer be updated and will be removed in a future release. The Django
+ Migration framework, found in Django 1.7 and above, should be used instead.
diff --git a/docs/releases/cashmere.rst b/docs/releases/cashmere.rst
new file mode 100644
index 0000000..9db9f8f
--- /dev/null
+++ b/docs/releases/cashmere.rst
@@ -0,0 +1,82 @@
+v1.1 Series ("Cashmere")
+========================
+
+1.1.3
+-----
+
+This release fixes a number of issues with the 1.1.2 release.
+
+Bug Fixes
+~~~~~~~~~
+
+- Some Python 3 issues are resolved in `pwclient`
+
+- `pwclient` now functions as expected behind a proxy
+
+1.1.2
+-----
+
+This release fixed a number of issues with the 1.1.1 release.
+
+Bug Fixes
+~~~~~~~~~
+
+- Headers containing invalid characters or codings are now parsed correctly
+
+- Patches can no longer be delegated to any user
+
+ This had significant performance impacts and has been reverted.
+
+1.1.1
+-----
+
+This release fixed a number of issues with the 1.1.0 release.
+
+Bug Fixes
+~~~~~~~~~
+
+- Numerous issues in the `parsemail.py`, `parsearchive.py` and `parsemail.sh`
+ scripts are resolved
+
+- Permissions of database tables, as set by `grant-all` SQL scripts, are now
+ set for tables added in Patchwork 1.1.0
+
+- Some performance and usability regressions in the UI are resolved
+
+1.1.0
+-----
+
+This release focuses on usability and maintainability, and sets us up nicely
+for a v2.0.0 release in the near future. Feature highlights of v1.1.0 include:
+
+- Automated delegation of patches, based on the files modified in said patches.
+
+- Storing of test results, a.k.a. "checks", on a patch-by-patch basis.
+
+- Delegation of patches to any registered Patchwork user (previously one had to
+ be a registered maintainer).
+
+- Overhaul of the web UI, which is now based on Bootstrap.
+
+- Python 3 support.
+
+New Features
+~~~~~~~~~~~~
+
+- The web UI is updated to reflect modern web standards. Bootstrap 3.x is used.
+
+- Python 3.4 is now supported
+
+- Checks, which can be used to report the status of tests, have been added
+
+- Automatic delegation of patches based on file path
+
+- Automated documentation for the XML-RPC API. This can be found at the
+ '/xmlrpc' in most Patchwork deployments
+
+- Vagrant is now integrated for use during development
+
+Upgrade Notes
+~~~~~~~~~~~~~
+
+- Patches can now be delegated to any Patchwork user.
diff --git a/docs/releases/unreleased.rst b/docs/releases/unreleased.rst
index 720c149..23caa95 100644
--- a/docs/releases/unreleased.rst
+++ b/docs/releases/unreleased.rst
@@ -2,4 +2,3 @@ Unreleased
==========
.. release-notes::
-