Update doxygen documentation #357
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
| name: CI Checks | |
| on: | |
| push: | |
| branches: ["**"] | |
| pull_request: | |
| branches: [main] | |
| workflow_dispatch: | |
| jobs: | |
| unittest: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Clone This Repo | |
| uses: actions/checkout@v3 | |
| - name: Build | |
| run: | | |
| sudo apt-get install -y lcov sed | |
| cmake -S test -B build/ \ | |
| -G "Unix Makefiles" \ | |
| -DCMAKE_BUILD_TYPE=Debug \ | |
| -DCMAKE_C_FLAGS='--coverage -Wall -Wextra -Werror' | |
| make -C build/ all | |
| - name: Test | |
| run: | | |
| cd build/ | |
| ctest -E system --output-on-failure | |
| cd .. | |
| - name: Run Coverage | |
| run: | | |
| make -C build/ coverage | |
| declare -a EXCLUDE=("\*test\*" "\*CMakeCCompilerId\*" "\*mocks\*" "\*source\*" "\*vendor/unity\*" "\*_deps\*") | |
| echo ${EXCLUDE[@]} | xargs lcov --rc lcov_branch_coverage=1 -r build/coverage.info -o build/coverage.info | |
| lcov --rc lcov_branch_coverage=1 --list build/coverage.info | |
| - name: Check Coverage | |
| uses: FreeRTOS/CI-CD-Github-Actions/coverage-cop@main | |
| with: | |
| coverage-file: ./build/coverage.info | |
| complexity: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Check complexity | |
| uses: FreeRTOS/CI-CD-Github-Actions/complexity@main | |
| with: | |
| path: ./ | |
| doxygen: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Run doxygen build | |
| uses: FreeRTOS/CI-CD-Github-Actions/doxygen@main | |
| with: | |
| path: ./ | |
| spell-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Clone This Repo | |
| uses: actions/checkout@v3 | |
| - name: Run spellings check | |
| uses: FreeRTOS/CI-CD-Github-Actions/spellings@main | |
| with: | |
| path: ./ | |
| formatting: | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Check formatting | |
| uses: FreeRTOS/CI-CD-Github-Actions/formatting@main | |
| with: | |
| path: ./ | |
| git-secrets: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Checkout awslabs/git-secrets | |
| uses: actions/checkout@v3 | |
| with: | |
| repository: awslabs/git-secrets | |
| ref: master | |
| path: git-secrets | |
| - name: Install git-secrets | |
| run: cd git-secrets && sudo make install && cd .. | |
| - name: Run git-secrets | |
| run: | | |
| git-secrets --register-aws | |
| git-secrets --scan | |
| memory_statistics: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Clone coreJSON | |
| run: git clone https://github.com/FreeRTOS/coreJSON.git --depth 1 --branch v3.2.0 | |
| - name: Install Python3 | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: "3.11.0" | |
| - name: Measure sizes | |
| uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@main | |
| with: | |
| config: .github/memory_statistics_config.json | |
| check_against: docs/doxygen/include/size_table.md | |
| link-verifier: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Check Links | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| uses: FreeRTOS/CI-CD-Github-Actions/link-verifier@main | |
| with: | |
| exclude-urls: https://s3.region.amazonaws.com/joe-ota, https://www.misra.org.uk | |
| verify-manifest: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| sparse-checkout: . | |
| - name: Run manifest verifier | |
| uses: FreeRTOS/CI-CD-GitHub-Actions/manifest-verifier@main | |
| with: | |
| path: ./ | |
| fail-on-incorrect-version: true | |
| proof_ci: | |
| if: ${{ github.event.pull_request }} | |
| runs-on: cbmc_ubuntu-latest_16-core | |
| steps: | |
| - name: Set up CBMC runner | |
| uses: FreeRTOS/CI-CD-Github-Actions/set_up_cbmc_runner@main | |
| - name: Run CBMC | |
| uses: FreeRTOS/CI-CD-Github-Actions/run_cbmc@main | |
| with: | |
| proofs_dir: test/cbmc | |
| run_cbmc_proofs_command: ./run_proofs.sh |