diff options
author | Stephen Finucane <stephen@that.guru> | 2017-03-22 23:03:00 +0000 |
---|---|---|
committer | Stephen Finucane <stephen@that.guru> | 2017-04-18 22:08:32 +0100 |
commit | bc2f6162acd5cbf9b16959fb28b726ba12d49767 (patch) | |
tree | 1ab85af801dc82d8031c1f49e8a84ad5d9bb9efd | |
parent | 3031c9d5647870aff7dae812368add11421a626e (diff) | |
download | patchwork-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>
-rw-r--r-- | CHANGELOG.md | 189 | ||||
-rw-r--r-- | UPGRADING.md | 4 | ||||
-rw-r--r-- | docs/index.rst | 3 | ||||
-rw-r--r-- | docs/releases/alpaca.rst | 10 | ||||
-rw-r--r-- | docs/releases/burlap.rst | 99 | ||||
-rw-r--r-- | docs/releases/cashmere.rst | 82 | ||||
-rw-r--r-- | docs/releases/unreleased.rst | 1 |
7 files changed, 194 insertions, 194 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 9dac8a4..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,189 +0,0 @@ -# Change Log - -All notable changes to this project will be documented in this file. Please -refer to the release notes for more detailed information, e.g. how to upgrade. - -This project adheres to [Semantic Versioning](http://semver.org/). - -## [Unreleased] - -This release added support for a REST API, cover letter parsing, and the latest -versions of both Django and Python. - -### Added - -- REST API support (Django >= 1.8 only) -- Cover letter support -- Series support -- Comment permalinks -- Django debug toolbar support for developers -- Django 1.9 and 1.10 support -- Python 3.5 support -- Docker support for developers -- Sample deployment documentation -- User documentation - -### Changed - -- The `parsemail.py` and `parsearchive.py` scripts have been replaced by the - `parsemail` and `parsearchive` management commands -- Significant rework of tests -- A user's name will now be updated on each email received from them - -### Fixed - -- Numerous typos and other issues in both documentation and code -- Various UI and performance improvements -- Checks are now displayed with their associated owner, thus preventing - spoofing -- `user at domain`-style email address, commonly found in Mailman archives, are - now handled correctly -- Unicode characters transmitted over the XML-RPC API are now handled correctly - under Python 3 - -### Removed - -- `parser.py` can no longer be exected as a script - -### Deprecated - -- Django 1.7 support will be removed in a future release - -## [1.1.1] - 2016-03-29 - -This release fixed a number of issues with the [1.1.0] release. - -## Fixed - -- Numerous issues in the `parsemail.py`, `parsearchive.py` and `parsemail.sh` - scripts -- Permissions of database tables as set by `grant-all` SQL scripts -- Misc. UI and performance improvements - -## [1.1.0] - 2016-03-03 - -This release overhauled the web UI and added support for automatic delegation -of patches, test result capture, and Python 3.4. - -### Added - -- Python 3.4 support -- Check feature, which can be used to report the status of tests -- 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 support for developers -- Selenium-based UI tests for developers - -### Changed - -- Overhauled the web UI to reflect modern web standards -- Patches can now be delegated to any Patchwork user -- Significant updates to the documentation -- Assorted cleanup tasks and bug fixes - -## [1.0.0] - 2015-10-26 - -### Added - -- Patch tag infrastructure feature, which provides a quick summary of patch - "tags" (e.g. `Acked-by`, `Reviewed-by`, ...) found in a patch and its replies -- Django 1.7 and Django 1.8 support -- Django `staticfiles` support, which should be used to gather static files for - for serving via a web server -- tox support for developers - -### Changed - -- Migrations are now executed using the Django migrations framework -- Moved Patchwork source from the `apps` directory to the top level directory -- The `cron` Django management command has replaced the `bin/patchwork-cron` - script -- Rewrote documentation to reflect changes in development and deployment best - practices over the past few years -- Reworked `requirements.txt` and `settings.py` files - -### Removed - -- Django 1.5 support -- Defunct Python 2.5 code -- Numerous dead files/code - -### Deprecated - -- Django 1.6 support will be removed in a future release -- Raw SQL migration scripts, previously found at `lib/sql/migration`, will no - longer be provided. Use the Django Migration framework found in Django 1.7 - and above - -### Additional notes - -This version changes a few admin-visible components of Patchwork, so upgrading -involves a few steps. - -#### Update settings - -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. - -#### Fix external references - -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`. - -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 - -Finally, as 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 - -#### Migrate to Django Migrations - -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 - -#### Migrate to Django Staticfiles - -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's configuration to serve the static content from -this new location. Refer to the sample web configuration files provided in -`lib` for more information. - -## [0.9.0] - 2015-03-22 - -**NOTE:** 1.0.0 was the first release of Patchwork adopting semantic versioning. -For information on *"0.9.0"* and before, please refer to Git logs. - -[Unreleased]: https://github.com/getpatchwork/patchwork/compare/v1.1.0...HEAD -[1.1.0]: https://github.com/getpatchwork/patchwork/compare/v1.0.0...v1.1.0 -[1.0.0]: https://github.com/getpatchwork/patchwork/compare/v0.9.0...v1.0.0 -[0.9.0]: https://github.com/getpatchwork/patchwork/compare/c561ebe...v0.9.0 - diff --git a/UPGRADING.md b/UPGRADING.md deleted file mode 100644 index 1089194..0000000 --- a/UPGRADING.md +++ /dev/null @@ -1,4 +0,0 @@ -# Patchwork Upgrade Guide - -For information on upgrading Patchwork instances, refer to the -[changelog](./CHANGELOG.md). diff --git a/docs/index.rst b/docs/index.rst index cafa485..6a61bad 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -57,3 +57,6 @@ of community projects. :caption: Release Notes releases/unreleased + releases/cashmere + releases/burlap + releases/alpaca 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:: - |