Skip to content

Commit

Permalink
Update changelog and notes
Browse files Browse the repository at this point in the history
  • Loading branch information
hmpf committed Oct 10, 2024
1 parent 537afc4 commit a8984e1
Show file tree
Hide file tree
Showing 11 changed files with 66 additions and 24 deletions.
52 changes: 52 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,58 @@ This project uses [*towncrier*](https://towncrier.readthedocs.io/) and the chang

<!-- towncrier release notes start -->

## [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


Expand Down
14 changes: 14 additions & 0 deletions NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions changelog.d/+add-customization-section.added.md

This file was deleted.

4 changes: 0 additions & 4 deletions changelog.d/+convert-exceptions.changed.md

This file was deleted.

3 changes: 0 additions & 3 deletions changelog.d/+docs-reference-section.changed.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+fix-open-api-parameters.fixed.md

This file was deleted.

4 changes: 0 additions & 4 deletions changelog.d/+fix-some-openapi-warnings.changed.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog.d/+middleware-app-setting-docs.changed.md

This file was deleted.

3 changes: 0 additions & 3 deletions changelog.d/+oauth2.removed.md

This file was deleted.

2 changes: 0 additions & 2 deletions changelog.d/+replacable-base-template.changed.md

This file was deleted.

4 changes: 0 additions & 4 deletions changelog.d/+simplify-filter-plugin.changed.md

This file was deleted.

0 comments on commit a8984e1

Please sign in to comment.