Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🔖 Release 2.6.0 #344

Merged
merged 1 commit into from
Mar 4, 2025
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
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[bumpversion]
commit = False
tag = False
current_version = 2.5.0
current_version = 2.6.0

[bumpversion:file:README.rst]

Expand Down
38 changes: 38 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,44 @@
Change history
==============

2.6.0
=====
*March, 4, 2025*

**New features**

* [:open-klant:`233`] Fix set of values for PartijIdentificatoren (ENUM)
* [:open-klant:`267`] Enforce uniqueness of Partij and PartijIdentificatoren
* [:open-klant:`309`] Add separate fields for Dutch addresses next to address lines 1 to 3
* [:open-klant:`310`] Update BAG ID fields with new validations
* [:open-klant:`311`] Update country codes fields with ISO 3166

.. warning::

Issues ``#311``, ``#310``, ``#267`` modify existing fields and add new constraints to models, which can cause them to break,
as some previous values will no longer be valid.
During migration, invalid values are logged so that they can be fixed manually and then migrations have to be executed again.


**Project maintenance**

* Upgrading dependencies:

* Upgrade open-api-framework to 0.9.3
* Upgrade Django to 4.2.19
* Upgrade cryptography to 44.0.1
* [:open-klant:`324`] Upgrade django-setup-configuration to 0.7.1
* [:open-klant:`324`] Upgrade mozilla-django-oidc-db to 0.22.0
* [:open-api-framework:`79`] Disable admin nav sidebar
* [:open-api-framework:`99`] Add quick-start workflow to test docker-compose.yml
* [:open-api-framework:`107`] Add release template
* [:open-klant:`299`] Add Nginx to Open Klant helm chart

**Documentation**

* [:open-klant:`324`] Update documentation for setup-configuration


2.5.0
=====
*January, 28, 2025*
Expand Down
7 changes: 5 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Open Klant
==========

:Version: 2.5.0
:Version: 2.6.0
:Source: https://github.com/maykinmedia/open-klant
:Keywords: klanten, klantinteracties, contactmomenten, api, common ground
:License: EUPL
Expand Down Expand Up @@ -39,7 +39,10 @@ Open Klant versie API versie Release datum API specificatie
================== ============== ============= ================
master/latest n/a n/a `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/master/src/openklant/components/klantinteracties/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/master/src/openklant/components/klantinteracties/openapi.yaml>`_,
(`diff <https://github.com/maykinmedia/open-klant/compare/2.5.0..master>`_)
(`diff <https://github.com/maykinmedia/open-klant/compare/2.6.0..master>`_)
2.6.0 0.1.0 2025-03-04 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/2.6.0/src/openklant/components/klantinteracties/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/2.6.0/src/openklant/components/klantinteracties/openapi.yaml>`_,
(`diff <https://github.com/maykinmedia/open-klant/compare/2.5.0..2.6.0>`_)
2.5.0 0.0.4 2025-01-28 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/2.5.0/src/openklant/components/klantinteracties/openapi.yaml>`_,
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/maykinmedia/open-klant/2.5.0/src/openklant/components/klantinteracties/openapi.yaml>`_,
(`diff <https://github.com/maykinmedia/open-klant/compare/2.4.0..2.5.0>`_)
Expand Down
3 changes: 3 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.. _changelog:

.. include:: ../CHANGELOG.rst
13 changes: 13 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.todo",
"sphinx.ext.extlinks",
"sphinx.ext.intersphinx",
"sphinx.ext.autodoc",
"django_setup_configuration.documentation.setup_config_example",
Expand Down Expand Up @@ -110,3 +111,15 @@
r"https://.*kvk\.nl*",
r"https://gdpr.eu*",
]

extlinks = {
"open-klant": ("https://github.com/maykinmedia/open-klant/issues/%s", "#%s"),
"open-api-framework": (
"https://github.com/maykinmedia/open-api-framework/issues/%s",
"#%s",
),
"charts": (
"https://github.com/maykinmedia/charts/issues/%s",
"#%s",
),
}
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,4 @@ Open Klant `is`_ and only uses open source.

installation/index
development/index
changelog
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "openklant",
"version": "2.5.0",
"version": "2.6.0",
"description": "openklant project",
"main": "src/static/openklant/js/openklant.js",
"directories": {
Expand Down
7 changes: 4 additions & 3 deletions requirements/base.txt
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,14 @@ coreapi==2.3.3
# via commonground-api-common
coreschema==0.0.4
# via coreapi
cryptography==43.0.0
cryptography==44.0.1
# via
# django-simple-certmanager
# josepy
# mozilla-django-oidc
# pyopenssl
# webauthn
django==4.2.17
django==4.2.19
# via
# commonground-api-common
# django-admin-index
Expand Down Expand Up @@ -268,7 +268,7 @@ pyjwt==2.9.0
# via
# commonground-api-common
# zgw-consumers
pyopenssl==24.2.1
pyopenssl==25.0.0
# via
# josepy
# webauthn
Expand Down Expand Up @@ -339,6 +339,7 @@ typing-extensions==4.12.2
# mozilla-django-oidc-db
# pydantic
# pydantic-core
# pyopenssl
# qrcode
# zgw-consumers
tzdata==2024.1
Expand Down
7 changes: 4 additions & 3 deletions requirements/ci.txt
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ coreschema==0.0.4
# coreapi
coverage==4.5.4
# via codecov
cryptography==43.0.0
cryptography==44.0.1
# via
# -c requirements/base.txt
# -r requirements/base.txt
Expand All @@ -149,7 +149,7 @@ cssselect==1.2.0
# via pyquery
dill==0.3.8
# via pylint
django==4.2.17
django==4.2.19
# via
# -c requirements/base.txt
# -r requirements/base.txt
Expand Down Expand Up @@ -593,7 +593,7 @@ pyjwt==2.9.0
# zgw-consumers
pylint==3.2.6
# via -r requirements/test-tools.in
pyopenssl==24.2.1
pyopenssl==25.0.0
# via
# -c requirements/base.txt
# -r requirements/base.txt
Expand Down Expand Up @@ -766,6 +766,7 @@ typing-extensions==4.12.2
# mozilla-django-oidc-db
# pydantic
# pydantic-core
# pyopenssl
# qrcode
# zgw-consumers
tzdata==2024.1
Expand Down
7 changes: 4 additions & 3 deletions requirements/dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ coverage==4.5.4
# -c requirements/ci.txt
# -r requirements/ci.txt
# codecov
cryptography==43.0.0
cryptography==44.0.1
# via
# -c requirements/ci.txt
# -r requirements/ci.txt
Expand All @@ -182,7 +182,7 @@ dill==0.3.8
# -c requirements/ci.txt
# -r requirements/ci.txt
# pylint
django==4.2.17
django==4.2.19
# via
# -c requirements/ci.txt
# -r requirements/ci.txt
Expand Down Expand Up @@ -695,7 +695,7 @@ pylint==3.2.6
# via
# -c requirements/ci.txt
# -r requirements/ci.txt
pyopenssl==24.2.1
pyopenssl==25.0.0
# via
# -c requirements/ci.txt
# -r requirements/ci.txt
Expand Down Expand Up @@ -921,6 +921,7 @@ typing-extensions==4.12.2
# mozilla-django-oidc-db
# pydantic
# pydantic-core
# pyopenssl
# qrcode
# zgw-consumers
tzdata==2024.1
Expand Down
2 changes: 1 addition & 1 deletion src/openklant/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from .celery import app as celery_app

__all__ = ("celery_app",)
__version__ = "2.5.0"
__version__ = "2.6.0"
__author__ = "Maykin"
__homepage__ = "https://github.com/maykinmedia/open-klant"
2 changes: 1 addition & 1 deletion src/openklant/components/contactgegevens/openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: contactgegevens
version: 1.0.0
version: 1.1.0
description: |2
Description WIP.
Expand Down
2 changes: 1 addition & 1 deletion src/openklant/components/klantinteracties/openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: klantinteracties
version: 0.0.4
version: 0.1.0
description: |2

Description WIP.
Expand Down Expand Up @@ -1867,7 +1867,7 @@
description: Maak een KlantContact, Betrokkene en een OnderwerpObject aan.
summary: Maak een KlantContact, Betrokkene en een OnderwerpObject aan.
tags:
- maak-klantcontact

Check warning on line 1870 in src/openklant/components/klantinteracties/openapi.yaml

View workflow job for this annotation

GitHub Actions / open-api-workflow-lint-oas (klantinteracties) / lint-oas-files

operation-tag-defined Operation tags should be defined in global tags.
requestBody:
content:
application/json:
Expand Down Expand Up @@ -4414,7 +4414,7 @@
type: array
items:
$ref: '#/components/schemas/CategorieRelatie'
PaginatedDigitaalAdresList:

Check warning on line 4417 in src/openklant/components/klantinteracties/openapi.yaml

View workflow job for this annotation

GitHub Actions / open-api-workflow-lint-oas (klantinteracties) / lint-oas-files

oas3-unused-components-schema Potentially unused components schema has been detected.
type: object
required:
- count
Expand Down Expand Up @@ -4529,7 +4529,7 @@
type: array
items:
$ref: '#/components/schemas/InterneTaak'
PaginatedKlantcontactList:

Check warning on line 4532 in src/openklant/components/klantinteracties/openapi.yaml

View workflow job for this annotation

GitHub Actions / open-api-workflow-lint-oas (klantinteracties) / lint-oas-files

oas3-unused-components-schema Potentially unused components schema has been detected.
type: object
required:
- count
Expand Down Expand Up @@ -4598,7 +4598,7 @@
type: array
items:
$ref: '#/components/schemas/PartijIdentificator'
PaginatedPartijList:

Check warning on line 4601 in src/openklant/components/klantinteracties/openapi.yaml

View workflow job for this annotation

GitHub Actions / open-api-workflow-lint-oas (klantinteracties) / lint-oas-files

oas3-unused-components-schema Potentially unused components schema has been detected.
type: object
required:
- count
Expand Down
6 changes: 2 additions & 4 deletions src/openklant/conf/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@
# Remove the reference - we don't have a single API version.
del API_VERSION # noqa

KLANTEN_API_VERSION = "1.0.0"
CONTACTMOMENTEN_API_VERSION = "1.0.0"
KLANTINTERACTIES_API_VERSION = "0.0.4"
CONTACTGEGEVENS_API_VERSION = "1.0.0"
KLANTINTERACTIES_API_VERSION = "0.1.0"
CONTACTGEGEVENS_API_VERSION = "1.1.0"

REST_FRAMEWORK = BASE_REST_FRAMEWORK.copy()
REST_FRAMEWORK["PAGE_SIZE"] = 100
Expand Down