Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,66 @@
Changelog
=========

1.0.0 (2025-10-23)
==================

After a long time we feel the library is finally ready for a 1.0 version!

Releases 0.17.0 and 0.24.0 included a large rework of the architecture of the library,
which we considered essential before even thinking of a 1.0 version. Since then, we've
found no major issues and have adapted the library in a number of real projects in
production with varying degrees of complexity.

From now on, breaking changes will result in a major version bump.

This release itself contains some (technically) breaking changes, but we expect they won't
really affect you.

**💥 Breaking changes**

* Dropped support for Python 3.10
* Dropped support for Python 3.11
* Reworked types and classes used for the plugin system, in particular:

* Removed :class:`mozilla_django_oidc_db.plugins.OIDCBasePluginProtocol`, instead there is
an abstract base class :class:`mozilla_django_oidc_db.plugins.BaseOIDCPlugin`.
* Removed :class:`mozilla_django_oidc_db.plugins.BaseOIDCPlugin`, instead there is
:class:`mozilla_django_oidc_db.plugins.BaseOIDCPlugin`.
* Removed :class:`mozilla_django_oidc_db.plugins.AnonymousUserOIDCPluginProtocol`,
instead there is an abstract base class
:class:`mozilla_django_oidc_db.plugins.AnonymousUserOIDCPlugin`.
* Removed :class:`mozilla_django_oidc_db.plugins.AbstractUserOIDCPluginProtocol`,
instead there is an abstract base class
:class:`mozilla_django_oidc_db.plugins.AbstractUserOIDCPlugin`.

Typically now you should only be subclassing either ``AnonymousUserOIDCPlugin`` or
``AbstractUserOIDCPlugin`` - they inherit from the abstract base class and provide
all necessary functionalities.

* The django-setup-configuration format appears to not be (fully) backwards compatible
since release 0.24.0. Downstream projects should mention this in their changelogs
and/or provide a migration path.

**New features**

* [`#121`_] Added Dutch translations.

**Bugfixes**

* [`#120`_] Fixed the retrieval of optional endpoints causing database errors.
* [`#113`_] Removed Open Forms reference in generic failure template.

**Project maintenance**

* [`#154`_] Improved documentation for setup-configuration integration.
* Improved the static type hints and added type-checking to the CI pipeline.
* Updated to modern Python syntax.

.. _#154: https://github.com/maykinmedia/mozilla-django-oidc-db/issues/154
.. _#120: https://github.com/maykinmedia/mozilla-django-oidc-db/issues/120
.. _#113: https://github.com/maykinmedia/mozilla-django-oidc-db/issues/113
.. _#121: https://github.com/maykinmedia/mozilla-django-oidc-db/issues/121

0.25.1 (2025-08-25)
===================

Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
mozilla-django-oidc-db
======================

:Version: 0.25.1
:Version: 1.0.0
:Source: https://github.com/maykinmedia/mozilla-django-oidc-db
:Keywords: OIDC, django, database, authentication

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
author = "Maykin Media"

# The full version, including alpha/beta/rc tags
release = "0.25.1"
release = "1.0.0"


# -- General configuration ---------------------------------------------------
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "mozilla-django-oidc-db"
version = "0.25.1"
version = "1.0.0"
description = "A database-backed configuration for mozilla-django-oidc"
authors = [
{name = "Maykin Media", email = "[email protected]"}
Expand All @@ -14,7 +14,7 @@ license = "MIT"
license-files = ["LICENSE"]
keywords = ["OIDC", "django", "database", "authentication"]
classifiers = [
"Development Status :: 4 - Beta",
"Development Status :: 5 - Production/Stable",
"Framework :: Django",
"Framework :: Django :: 4.2",
"Framework :: Django :: 5.2",
Expand Down Expand Up @@ -84,7 +84,7 @@ markers = [
]

[tool.bumpversion]
current_version = "0.25.1"
current_version = "1.0.0"
files = [
{filename = "pyproject.toml"},
{filename = "README.rst"},
Expand Down