MDEV-39806: Add a per-push/per-pull-request checker for Markdown API docs #12
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Generate Plugin API Docs | |
| on: | |
| push: | |
| branches: | |
| - 'main' | |
| pull_request: | |
| branches: | |
| - 'main' | |
| jobs: | |
| generate-docs: | |
| runs-on: ubuntu-latest | |
| container: | |
| image: ghcr.io/mariadb/mariadb-doc-gen:latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v7 | |
| - name: Generate documentation | |
| shell: bash | |
| run: | | |
| set -euo pipefail | |
| git config --global --add safe.directory `pwd` | |
| git submodule update --init --recursive libmariadb | |
| mkdir -p bld/docs/plugin-api | |
| target_dir=$(pwd)/bld/docs/plugin-api | |
| cd include/mysql | |
| bash -x generate_plugin_api_docs.sh "$target_dir" | |
| cd ../.. |