Skip to content

Commit

Permalink
ci: Run doxygen to check for correct markup (groonga#1830)
Browse files Browse the repository at this point in the history
Updated settings for running doxygen with CI.

* QUIET = YES
  * The warning log is hard to find, so the generation log is not output
* WARN_AS_ERROR = FAIL_ON_WARNINGS
  * If there is a warning, it should be terminated abnormally
  • Loading branch information
abetomo authored Jul 30, 2024
1 parent 099d4d8 commit 6af9ccb
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 2 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/document.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Build document
on:
push:
branches:
- main
- 'maintenance/**'
tags:
- '*'
paths:
- 'Rakefile'
- 'doc/Doxyfile'
- 'include/**/*.h'
- 'include/**/*.hpp'
- '.github/workflows/document.yml'
pull_request:
paths:
- 'Rakefile'
- 'doc/Doxyfile'
- 'include/**/*.h'
- 'include/**/*.hpp'
- '.github/workflows/document.yml'
concurrency:
group: ${{ github.head_ref || github.sha }}-${{ github.workflow }}
cancel-in-progress: true
jobs:
# todo: Build and publish the full document, including Sphinx.
doxygen:
name: Doxygen
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ruby/setup-ruby@v1
with:
ruby-version: ruby
- name: Install Doxygen
run: sudo apt install -y -V doxygen graphviz
- name: Run Doxygen
run: rake document:api
4 changes: 2 additions & 2 deletions doc/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -810,7 +810,7 @@ CITE_BIB_FILES =
# messages are off.
# The default value is: NO.

QUIET = NO
QUIET = YES

# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
Expand Down Expand Up @@ -852,7 +852,7 @@ WARN_NO_PARAMDOC = NO
# Possible values are: NO, YES and FAIL_ON_WARNINGS.
# The default value is: NO.

WARN_AS_ERROR = NO
WARN_AS_ERROR = FAIL_ON_WARNINGS

# The WARN_FORMAT tag determines the format of the warning messages that doxygen
# can produce. The string should contain the $file, $line, and $text tags, which
Expand Down

0 comments on commit 6af9ccb

Please sign in to comment.