MDEV-39806: Add a per-push/per-pull-request checker for Markdown API docs #5153
+50
−0
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| name: Generate Plugin API Docs | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - 'main' | ||
| - 'bb-*' | ||
| pull_request: | ||
| branches: | ||
| - 'main' | ||
|
There was a problem hiding this comment. This will only trigger if someone opens a Pull Request towards main or a bb-* branch. |
||
| - '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 \ | ||
|
There was a problem hiding this comment. You could've probably used |
||
| -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 | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you want this workflow to run on other branches and on Pull Requests that are not targeting
mainthen it is not enough to commit it to the
mainbranch.Every supported branch should have it.
Going one step back,
why you want this workflow to run for every
pushorbb-*branch?This is a lot of stress imposed on public GitHub runners; where's the added value? Because I see no mechanism where the results from a push are retrieved/analyzed.