Merge remote-tracking branch 'origin/topic/awelzel/ci-generate-docs-run-pre-commit'

* origin/topic/awelzel/ci-generate-docs-run-pre-commit:
  github/generate-docs: Run pre-commit
  cluster/backends/zeromq: Fix rst link in docs

.github/workflows/generate-docs.yml

@@ -73,6 +73,7 @@ jobs:
           # support and explicitly use `python3` for all invocations.
           sudo ln -sf /usr/bin/python3 /usr/local/bin/python
           sudo pip3 install --break-system-packages -r doc/requirements.txt
+          sudo pip3 install --break-system-packages pre-commit
 
       - name: ccache
         uses: hendrikmuhs/ccache-action@v1.2
@@ -89,6 +90,12 @@ jobs:
       - name: Check Spicy docs
         run: cd doc && make check-spicy-docs
 
+      # Cache pre-commit environment for reuse.
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: doc-pre-commit-3|${{ env.pythonLocation }}|${{ hashFiles('doc/.pre-commit-config.yaml') }}
+
       - name: Generate Docs
         run: |
           git config --global user.name zeek-bot
@@ -97,8 +104,12 @@ jobs:
           echo "*** Generating Zeekygen Docs ***"
           ./ci/update-zeekygen-docs.sh || exit 1
 
-          echo "*** Generating Sphinx Docs ***"
           cd doc
+
+          echo "*** Running pre-commit ***"
+          pre-commit run -a --show-diff-on-failure --color=always
+
+          echo "*** Generating Sphinx Docs ***"
           make > make.out 2>&1
           make_status=$?
           echo "*** Sphinx Build Output ***"

CHANGES

@@ -1,3 +1,12 @@
+7.2.0-dev.314 | 2025-03-12 13:10:58 +0100
+
+  * github/generate-docs: Run pre-commit (Arne Welzel, Corelight)
+
+    ...it's a bit unfortunate that we cannot use the action for this. It's
+    because ./doc is a submodule and not the main repo.
+
+  * cluster/backends/zeromq: Fix rst link in docs (Arne Welzel, Corelight)
+
 7.2.0-dev.310 | 2025-03-11 10:50:49 +0100
 
   * ci/opensuse-tumpleweed: Bust cache (Arne Welzel, Corelight)

VERSION

@@ -1 +1 @@
-7.2.0-dev.310
+7.2.0-dev.314

scripts/policy/frameworks/cluster/backend/zeromq/main.zeek

@@ -59,7 +59,7 @@ export {
 	## acts as a central broker.
 
 	## See ZeroMQ's `ZMQ_IO_THREADS documentation <http://api.zeromq.org/4-2:zmq-ctx-set#toc4>`_
-	## and the `I/O threads <https://zguide.zeromq.org/docs/chapter2/#I-O-Threads>`
+	## and the `I/O threads <https://zguide.zeromq.org/docs/chapter2/#I-O-Threads>`_
 	## section in the ZeroMQ guide for details.
 	const proxy_io_threads = 2 &redef;