From 2f2c924a3df4b34666f644c0fa2f9bc444a05e75 Mon Sep 17 00:00:00 2001 From: Steven Bal Date: Fri, 20 Dec 2024 09:36:25 +0100 Subject: [PATCH 1/4] :arrow_up: Upgrade open-api-framework to 0.9.1 --- requirements/base.txt | 2 +- requirements/ci.txt | 2 +- requirements/dev.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/requirements/base.txt b/requirements/base.txt index db44ad48..3236e673 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -243,7 +243,7 @@ mozilla-django-oidc-db[setup-configuration]==0.21.1 # open-api-framework notifications-api-common==0.3.1 # via commonground-api-common -open-api-framework==0.9.0 +open-api-framework==0.9.1 # via -r requirements/base.in orderedmultidict==1.0.1 # via furl diff --git a/requirements/ci.txt b/requirements/ci.txt index ec0691e5..b5287598 100644 --- a/requirements/ci.txt +++ b/requirements/ci.txt @@ -435,7 +435,7 @@ notifications-api-common==0.3.1 # via # -r requirements/base.txt # commonground-api-common -open-api-framework==0.9.0 +open-api-framework==0.9.1 # via -r requirements/base.txt orderedmultidict==1.0.1 # via diff --git a/requirements/dev.txt b/requirements/dev.txt index ea29fa21..2d5a7458 100644 --- a/requirements/dev.txt +++ b/requirements/dev.txt @@ -444,7 +444,7 @@ notifications-api-common==0.3.1 # via # -r requirements/base.txt # commonground-api-common -open-api-framework==0.9.0 +open-api-framework==0.9.1 # via -r requirements/base.txt orderedmultidict==1.0.1 # via From 38807b992fa432329e4e7a8065ec79040dde7d16 Mon Sep 17 00:00:00 2001 From: Steven Bal Date: Fri, 20 Dec 2024 09:47:39 +0100 Subject: [PATCH 2/4] :memo: Update envvar documentation --- docs/installation/config.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/installation/config.rst b/docs/installation/config.rst index cb3813e3..7754f3ba 100644 --- a/docs/installation/config.rst +++ b/docs/installation/config.rst @@ -76,10 +76,11 @@ Optional * ``EMAIL_HOST_PASSWORD``: password to connect to the mail server. Defaults to: ``(empty string)``. * ``EMAIL_USE_TLS``: whether to use TLS or not to connect to the mail server. Should be True if you're changing the ``EMAIL_PORT`` to 487. Defaults to: ``False``. * ``DEFAULT_FROM_EMAIL``: The default email address from which emails are sent. Defaults to: ``openklant@example.com``. -* ``LOG_STDOUT``: whether to log to stdout or not. Defaults to: ``False``. +* ``LOG_STDOUT``: whether to log to stdout or not. Defaults to: ``True``. * ``LOG_LEVEL``: control the verbosity of logging output. Available values are ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO`` and ``DEBUG``. Defaults to: ``WARNING``. * ``LOG_QUERIES``: enable (query) logging at the database backend level. Note that you must also set ``DEBUG=1``, which should be done very sparingly!. Defaults to: ``False``. * ``LOG_REQUESTS``: enable logging of the outgoing requests. Defaults to: ``False``. +* ``CELERY_LOGLEVEL``: control the verbosity of logging output for celery, independent of ``LOG_LEVEL``. Available values are ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO`` and ``DEBUG``. Defaults to: ``INFO``. * ``SESSION_COOKIE_AGE``: For how long, in seconds, the session cookie will be valid. Defaults to: ``1209600``. * ``SESSION_COOKIE_SAMESITE``: The value of the SameSite flag on the session cookie. This flag prevents the cookie from being sent in cross-site requests thus preventing CSRF attacks and making some methods of stealing session cookie impossible.Currently interferes with OIDC. Keep the value set at Lax if used. Defaults to: ``Lax``. * ``CSRF_COOKIE_SAMESITE``: The value of the SameSite flag on the CSRF cookie. This flag prevents the cookie from being sent in cross-site requests. Defaults to: ``Strict``. From ed43be987b151ae8ad8efa2cef87a46c7fde8c4f Mon Sep 17 00:00:00 2001 From: Steven Bal Date: Fri, 20 Dec 2024 09:56:45 +0100 Subject: [PATCH 3/4] :construction_worker: [maykinmedia/open-api-framework#92] Make sure docs are built in CI --- .github/workflows/ci.yml | 4 +++- docs/conf.py | 8 +++++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 43ac673a..f4deea7e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -118,13 +118,15 @@ jobs: id: image-name open-api-ci: - uses: maykinmedia/open-api-workflows/.github/workflows/ci.yml@v1 + uses: maykinmedia/open-api-workflows/.github/workflows/ci.yml@v3.0.2 needs: - store-reusable-workflow-vars with: main-branch: 'master' + run-docs: true python-version: '3.11' docker-image-name: ${{ needs.store-reusable-workflow-vars.outputs.image-name }} + django-settings-module: openklant.conf.ci open-api-publish: uses: maykinmedia/open-api-workflows/.github/workflows/publish.yml@v1 diff --git a/docs/conf.py b/docs/conf.py index 73aa095a..0c582bb0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -67,8 +67,8 @@ None, ), "django": ( - "http://docs.djangoproject.com/en/3.2/", - "http://docs.djangoproject.com/en/3.2/_objects/", + "http://docs.djangoproject.com/en/4.2/", + "http://docs.djangoproject.com/en/4.2/_objects/", ), } @@ -77,7 +77,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_logo = "logo.svg" +# html_logo = "logo.svg" html_theme = "sphinx_rtd_theme" # Add any paths that contain custom static files (such as style sheets) here, @@ -90,6 +90,8 @@ todo_include_todos = True +linkcheck_retries = 3 + linkcheck_ignore = [ r"urn:*", r"https?://.*\.gemeente.nl", From 280a652a59436862fd5797cf45088a746c130666 Mon Sep 17 00:00:00 2001 From: Steven Bal Date: Fri, 20 Dec 2024 10:19:04 +0100 Subject: [PATCH 4/4] :construction_worker: Use proper default branch in code-analysis workflow --- .github/workflows/code-analysis.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/code-analysis.yml b/.github/workflows/code-analysis.yml index 8b3ac9ad..b3b7d3ca 100644 --- a/.github/workflows/code-analysis.yml +++ b/.github/workflows/code-analysis.yml @@ -8,11 +8,11 @@ name: "CodeQL" on: push: branches: - - main + - master pull_request: # The branches below must be a subset of the branches above branches: - - main + - master schedule: - cron: '0 23 * * 6'