forked from groonga/groonga
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: Run doxygen to check for correct markup (groonga#1830)
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
Showing
2 changed files
with
40 additions
and
2 deletions.
There are no files selected for viewing
This file contains 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,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 |
This file contains 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