JSON-RPC: Docs: Add and CI-integrate API doc generator

Co-authored-by: Christian Hoffmann <mail@hoffmann-christian.info>
jamulussoftware · Mar 9, 2022 · bb1b6ee · bb1b6ee
1 parent d704717
commit bb1b6ee
Show file tree

Hide file tree

Showing 3 changed files with 693 additions and 0 deletions.
diff --git a/.github/workflows/check-json-rpcs-docs.yml b/.github/workflows/check-json-rpcs-docs.yml
@@ -0,0 +1,22 @@
+name: Check JSON-RPC docs
+
+on:
+  pull_request:
+    branches:
+      - master
+    paths:
+      - 'tools/generate_json_rpc_docs.py'
+      - 'src/*rpc*.cpp'
+
+jobs:
+  check-json-rpc-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: ./tools/generate_json_rpc_docs.py
+      - env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          [[ -z "$(git status --porcelain=v1)" ]] && exit 0
+          echo "Please run ./tools/generate_json_rpc_docs.py to regenerate docs/JSON-RPC.md"
+          exit 1