diff --git a/CHANGELOG.md b/CHANGELOG.md index da63bd0b8..c74f51474 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,58 @@ This project uses [*towncrier*](https://towncrier.readthedocs.io/) and the chang +## [1.23.0] - 2024-10-10 + +This is the first version of Argus to be able to run on Django 5.1. + +Support for Python 3.8 has been dropped. + +The most visible changes are in the documentation. + +### Removed + +- As part of refactoring some authentication utility functions the function + `get_psa_authentication_names()` has been removed as it wasn't used anywhere + in Argus proper. + +### Added + +- Added a new section "Customization" to the docs, for customizations that go + beyond integrations. +- Documented how to use (EXTRA|OVERRIDING)\_APPS to add app-specific + middleware. +- There's a new howto, for how to regenerate the ER diagram in the docs. + +### Changed + +- So. Many. Refactors. +- There should be fewer warnings/log messages when visiting the autogenerated + OpenAPI. There is one commit per change to help with future wrangling. There + are still some warnings left; getting rid of those is left as an exercise to + the reader. +- The favicon and template for the simple page generated on "/" are now + replacable by adding an app at the start of INSTALLED\_APPS that has the new + files. +- Plenty of dependencies and sub-dependencies were upgraded +- Django ValidationErrors are converted to DRF ValidationErrors. This makes it + possible to move some validation from API model serializers to the actual + model, which means validating only once and the API and future Django + frontend seeing the same errors. +- Moved reference docs into their own section (as per Diátaxis), improved the + looks and contents of the explanation and terms, and added a very brief + explanation of each model. +- Moved site TEMPLATES and STATIC to a mini-app to make them replaceable via an + app added before it in INSTALLED\_APPS. +- Removed `FilterSerializer` and `validate_jsonfilter` from the filter plugin + mechanism since they just wrap `FilterBlobSerializer`. (This also means + `FilterBlobSerializer` can no longer be in the same file as + `FilterSerializer`.) + +### Fixed + +- Fix OpenAPI parameters for `incidents/` and `incidents/mine/` + + ## [1.22.1] - 2024-09-05 diff --git a/NOTES.md b/NOTES.md index ab38d4e75..4a74616b2 100644 --- a/NOTES.md +++ b/NOTES.md @@ -3,6 +3,20 @@ This file documents changes to Argus that are relevant for operations and end-users. +## [1.23.0] - 2024-10-10 + +This is the first version of Argus to be able to run on Django 5.1. + +Support for Python 3.8 has been dropped. + +The most visible changes are in the documentation. + +The function `get_psa_authentication_names()` has been remooved, it was not in +use by us. + +How to customize filtering has changed, it is no longer necessary to override +`FilterSerializer` and `validate_jsonfilter`. + ## [1.22.0] - 2024-08-30 There's a backwards incompatible change to prepare for the next Django LTS diff --git a/changelog.d/+add-customization-section.added.md b/changelog.d/+add-customization-section.added.md deleted file mode 100644 index c755ae528..000000000 --- a/changelog.d/+add-customization-section.added.md +++ /dev/null @@ -1,2 +0,0 @@ -Added a new section "Customization" to the docs, for customizations that go -beyond integrations. diff --git a/changelog.d/+convert-exceptions.changed.md b/changelog.d/+convert-exceptions.changed.md deleted file mode 100644 index c3c343969..000000000 --- a/changelog.d/+convert-exceptions.changed.md +++ /dev/null @@ -1,4 +0,0 @@ -Convert Django ValidationErrors to DRF ValidationErrors. This makes it possible -to move some validation from API model serializers to the actual model, which -means validating only once and the API and future Django frontend seeing the -same errors. diff --git a/changelog.d/+docs-reference-section.changed.md b/changelog.d/+docs-reference-section.changed.md deleted file mode 100644 index 276d07048..000000000 --- a/changelog.d/+docs-reference-section.changed.md +++ /dev/null @@ -1,3 +0,0 @@ -Moved reference docs into their own section (as per Diataxis), improved the -looks and contents of the explanation and terms, and added a very brief -explanation of each model. diff --git a/changelog.d/+fix-open-api-parameters.fixed.md b/changelog.d/+fix-open-api-parameters.fixed.md deleted file mode 100644 index 5ef7bb455..000000000 --- a/changelog.d/+fix-open-api-parameters.fixed.md +++ /dev/null @@ -1 +0,0 @@ -Fix OpenAPI parameters for `incidents/` and `incidents/mine/` \ No newline at end of file diff --git a/changelog.d/+fix-some-openapi-warnings.changed.md b/changelog.d/+fix-some-openapi-warnings.changed.md deleted file mode 100644 index 6608fb1c0..000000000 --- a/changelog.d/+fix-some-openapi-warnings.changed.md +++ /dev/null @@ -1,4 +0,0 @@ -There should be fewer warnings/log messages when visiting the autogenerated -OpenAPI. There is one commit per change to help with future wrangling. There -are still some warnings left; getting rid of those is left as an exercise to -the reader. diff --git a/changelog.d/+middleware-app-setting-docs.changed.md b/changelog.d/+middleware-app-setting-docs.changed.md deleted file mode 100644 index 380d654d2..000000000 --- a/changelog.d/+middleware-app-setting-docs.changed.md +++ /dev/null @@ -1 +0,0 @@ -Documented how to use (EXTRA|OVERRIDING)\_APPS to add app-specific middleware. diff --git a/changelog.d/+oauth2.removed.md b/changelog.d/+oauth2.removed.md deleted file mode 100644 index 836e918ec..000000000 --- a/changelog.d/+oauth2.removed.md +++ /dev/null @@ -1,3 +0,0 @@ -As part of refactoring some authentication utility functions the function -`get_psa_authentication_names()` has been removed as it wasn't used anywhere in -Argus proper. diff --git a/changelog.d/+replacable-base-template.changed.md b/changelog.d/+replacable-base-template.changed.md deleted file mode 100644 index b2bf68d75..000000000 --- a/changelog.d/+replacable-base-template.changed.md +++ /dev/null @@ -1,2 +0,0 @@ -Moved site TEMPLATES and STATIC to a mini-app to make them replaceable via an -app added before it in INSTALLED_APPS. diff --git a/changelog.d/+simplify-filter-plugin.changed.md b/changelog.d/+simplify-filter-plugin.changed.md deleted file mode 100644 index c0c358f8f..000000000 --- a/changelog.d/+simplify-filter-plugin.changed.md +++ /dev/null @@ -1,4 +0,0 @@ -Removed `FilterSerializer` and `validate_jsonfilter` from the filter plugin -mechanism since they just wrap `FilterBlobSerializer`. (This also means -`FilterBlobSerializer` can no longer be in the same file as -`FilterSerializer`.)