summaryrefslogtreecommitdiff
path: root/CHANGELOG.md
diff options
context:
space:
mode:
authorStephen Finucane <stephen.finucane@intel.com>2015-10-16 20:29:53 +0100
committerStephen Finucane <stephen.finucane@intel.com>2015-10-26 20:24:25 +0000
commit9576870b4b764bae0b654b8bd2d1c78b2a8df932 (patch)
treedc5de19aaa5bec6ec98caf34cc0dc9249c298b74 /CHANGELOG.md
parent300e190370ccda0c78284f31b1ec077d2e94e247 (diff)
downloadpatchwork-9576870b4b764bae0b654b8bd2d1c78b2a8df932.tar
patchwork-9576870b4b764bae0b654b8bd2d1c78b2a8df932.tar.gz
doc: Add CHANGELOG and UPGRADING docs
The CHANGELOG document should describe the high level changes of the project. This will provide a human-readable way for people to evaluate the changes in each release. This file is based on the templates and general changelog "ethos" provided by 'Keep a CHANGELOG': http://keepachangelog.com/ The UPGRADING document provide instruction for system admininstrators managing patchwork deployments. At the moment, this document is a rename and minor reformatting of the existing 'docs/NEWS' document, but going forward documentation will be added for each new release. Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
Diffstat (limited to 'CHANGELOG.md')
-rw-r--r--CHANGELOG.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..541df38
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,58 @@
+# 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]
+
+...
+
+## [1.0.0] - 2015-10-26
+
+### Added
+
+- Patch tag infrastructure feature. This provide a quick summary of patch
+ 'tags' (e.g. `Acked-by`, `Reviewed-by`, ...) found in a patch and its replies
+- Support for Django 1.7 and Django 1.8
+- Support for Django Migrations. This will be the chosen method of making
+ database changes going forward. See below for more information
+- Support for tox
+- Django management commands, which replace the existing patchwork cron scripts
+- CHANGELOG.md and UPGRADING.md docs
+
+### Changed
+
+- Static files are now gather and served using the `django.contrib.staticfiles`
+ module, per Django best practices
+- Restructured directory per modern Django standards. The `apps` directory no
+ longer exists and patchwork source has instead been moved to the top level
+ directory
+- Rewrote documentation to reflect changes in development and deployment best
+ practices over the past few years
+- Reworked `requirements.txt` and `settings.py` files
+
+### Removed
+
+- Support for Django 1.5
+- Defunct Python 2.5 code
+- Numerous dead files/code
+- `bin/patchwork-cron` script, in favor of `cron` management command
+
+### Deprecated
+
+- Django 1.6 support will be removed in the next release
+- Django 1.7 supports Django Migrations and Django 1.8 requires them. This
+ negates the need for handwritten SQL migration scripts. Future releases will
+ no longer include these scripts and they will eventually be removed
+
+## [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.0.0...HEAD
+[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
+