From 538d42714f59284d06efefc3b992174c96044555 Mon Sep 17 00:00:00 2001
From: Georgi Kodinov <joro@mariadb.org>
Date: Fri, 29 May 2026 15:06:41 +0300
Subject: [PATCH] MDEV-39806: Add a per-push/per-pull-request checker for
 Markdown API docs

Create a GitHub action into the MariaDB server tree to build the Markdown
documentation using the cmake target provided by MDEV-39718.

This workflow generates API documentation for the plugin using a
Docker container packed with all the extra doxygen/moxygen tools
and the latest CMake dependencies.
---
 .github/workflows/generate-api-docs.yml | 50 +++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 .github/workflows/generate-api-docs.yml

diff --git a/.github/workflows/generate-api-docs.yml b/.github/workflows/generate-api-docs.yml
new file mode 100644
index 0000000000000..cb5a7f545c193
--- /dev/null
+++ b/.github/workflows/generate-api-docs.yml
@@ -0,0 +1,50 @@
+name: Generate Plugin API Docs
+
+on:
+  push:
+    branches:
+      - 'main'
+      - 'bb-*'
+  pull_request:
+    branches:
+      - 'main'
+      - 'bb-*'
+jobs:
+  generate-docs:
+    runs-on: ubuntu-latest
+    container:
+      image: quay.io/mariadb-foundation/bb-ecosystem:mariadb-doc-gen
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Generate documentation
+        shell: bash
+        run: |
+          set -euo pipefail
+          git config --global --add safe.directory `pwd`
+          git submodule update --init --recursive libmariadb
+          mkdir bld
+          cd bld
+          cmake -DENABLE_GCOV=OFF \
+                -DMYSQL_MAINTAINER_MODE=OFF \
+                -DPLUGIN_ARCHIVE=NO \
+                -DPLUGIN_MROONGA=NO \
+                -DPLUGIN_CONNECT=NO \
+                -DPLUGIN_SPIDER=NO \
+                -DPLUGIN_ROCKSDB=NO \
+                -DPLUGIN_OQGRAPH=NO \
+                -DPLUGIN_TOKUDB=NO \
+                -DWITH_MARIABACKUP=NO \
+                -DWITH_EMBEDDED_SERVER=OFF \
+                -DWITH_UNIT_TESTS=OFF \
+                -DCONC_WITH_UNITTEST=OFF \
+                -DWITH_WSREP=OFF \
+                -DWITHOUT_DYNAMIC_PLUGINS=0 \
+                -DWITH_SSL=system \
+                -DWITH_PCRE=system \
+                -DWITHOUT_SERVER=ON \
+                -DUPDATE_SUBMODULES=OFF \
+                -DWITH_GENERATED_DOCS=YES \
+                ..
+          cmake --build . --target=generated_docs_plugin_api