Merge pull request #306 from maykinmedia/issue/fix-ci-docs-build

👷 [maykinmedia/open-api-framework#92] Make sure docs are built in CI
maykinmedia · Dec 20, 2024 · 5f9302e · 5f9302e
2 parents 4715811 + 280a652
commit 5f9302e
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 10 deletions.
diff --git 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/.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'
 

diff --git 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",

diff --git 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: ``[email protected]``.
-* ``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``.

diff --git 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
@@ -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
@@ -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