Automatically detect missing doxygen comments (#1226)

Fixes #1216
This commit is contained in:
Alex Kremer
2024-03-05 12:37:16 +00:00
committed by GitHub
parent c7b637b3f3
commit 73d427c1cb
16 changed files with 234 additions and 132 deletions

View File

@@ -17,12 +17,27 @@ jobs:
- name: Run formatters
id: run_formatters
run: |
./.githooks/pre-commit
./.githooks/check-format
shell: bash
check_docs:
name: Check documentation
runs-on: ubuntu-20.04
container:
image: rippleci/clio_ci:latest
steps:
- uses: actions/checkout@v4
- name: Run linter
id: run_linter
run: |
./.githooks/check-docs
shell: bash
build:
name: Build
needs: check_format
needs:
- check_format
- check_docs
strategy:
fail-fast: false
matrix:

View File

@@ -59,11 +59,11 @@ jobs:
run: |
run-clang-tidy-17 -p build -j ${{ steps.number_of_threads.outputs.threads_number }} -fix -quiet 1>output.txt
- name: Run pre-commit hook
- name: Check format
if: ${{ steps.run_clang_tidy.outcome != 'success' }}
continue-on-error: true
shell: bash
run: ./.githooks/pre-commit
run: ./.githooks/check-format
- name: Print issues found
if: ${{ steps.run_clang_tidy.outcome != 'success' }}
@@ -88,6 +88,7 @@ jobs:
rm create_issue.log issue.md
- uses: crazy-max/ghaction-import-gpg@v5
if: ${{ steps.run_clang_tidy.outcome != 'success' }}
with:
gpg_private_key: ${{ secrets.ACTIONS_GPG_PRIVATE_KEY }}
passphrase: ${{ secrets.ACTIONS_GPG_PASSPHRASE }}