From 947d7e0055569ecd23815dbbdf96fbae2f14baea Mon Sep 17 00:00:00 2001
From: David Cermak <cermak@espressif.com>
Date: Fri, 20 Dec 2024 12:35:02 +0100
Subject: [PATCH] fix(mosq): Check that API docs are actual in CI

---
 .github/workflows/mosq__build.yml | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/.github/workflows/mosq__build.yml b/.github/workflows/mosq__build.yml
index 27ff2581c1..b970a2dca5 100644
--- a/.github/workflows/mosq__build.yml
+++ b/.github/workflows/mosq__build.yml
@@ -73,3 +73,15 @@ jobs:
           mv $dir build
           python -m pytest --log-cli-level DEBUG --junit-xml=./results_esp32_${{ matrix.idf_ver }}_${dir#"ci/build_"}.xml --target=esp32
           done
+
+  check_api_docs:
+    name: Checks API Docs up-to-date
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Checks API Docs is actual
+        run: |
+          cp api.md api_orig.md
+          cd components/mosquitto
+          ./generate_api_docs.sh
+          diff -wB api.md api_orig.md