Merge doxygen patch into v1.4.0 version (#186) #617
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 | |
| env: | |
| bashPass: \033[32;1mPASSED - | |
| bashInfo: \033[33;1mINFO - | |
| bashFail: \033[31;1mFAILED - | |
| bashEnd: \033[0m | |
| on: | |
| push: | |
| branches: ["**"] | |
| pull_request: | |
| branches: [main] | |
| workflow_dispatch: | |
| jobs: | |
| unittest: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Clone This Repo | |
| uses: actions/checkout@v4 | |
| - env: | |
| stepName: Build Unit Tests | |
| run: | | |
| # ${{ env.stepName }} | |
| echo -e "::group::${{ env.bashInfo }} ${{ env.stepName }} ${{ env.bashEnd }}" | |
| sudo apt-get install -y lcov | |
| cmake -S test -B build/ \ | |
| -G "Unix Makefiles" \ | |
| -DCMAKE_BUILD_TYPE=Debug \ | |
| -DUNITTEST=ON \ | |
| -DBUILD_CLONE_SUBMODULES=ON \ | |
| -DCMAKE_C_FLAGS='--coverage -Wall -Wextra -Werror -DNDEBUG' | |
| make -C build/ all | |
| echo "::endgroup::" | |
| echo -e "${{ env.bashPass }} ${{env.stepName}} ${{ env.bashEnd }}" | |
| - name: Run Unit Tests | |
| run: ctest --test-dir build -E system --output-on-failure | |
| - env: | |
| stepName: Line and Branch Coverage Build | |
| run: | | |
| # ${{ env.stepName }} | |
| echo -e "::group::${{ env.bashInfo }} Build Coverage Target ${{ env.bashEnd }}" | |
| # Build the coverage target | |
| make -C build/ coverage | |
| echo -e "::group::${{ env.bashInfo }} Generate Coverage Report ${{ env.bashEnd }}" | |
| # Generate coverage report, excluding extra directories | |
| lcov --rc lcov_branch_coverage=1 -r build/coverage.info -o build/coverage.info '*test*' '*CMakeCCompilerId*' '*mocks*' | |
| echo "::endgroup::" | |
| lcov --rc lcov_branch_coverage=1 --list build/coverage.info | |
| echo -e "${{ env.bashPass }} ${{env.stepName}} ${{ env.bashEnd }}" | |
| - name: Check Coverage | |
| uses: FreeRTOS/CI-CD-Github-Actions/coverage-cop@main | |
| with: | |
| coverage-file: ./build/coverage.info | |
| branch-coverage-min: 100 | |
| line-coverage-min: 100 | |
| complexity: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Check complexity - Common | |
| uses: FreeRTOS/CI-CD-Github-Actions/complexity@main | |
| with: | |
| path: ./ | |
| doxygen: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - 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@v4 | |
| - name: Run spellings check | |
| uses: FreeRTOS/CI-CD-Github-Actions/spellings@main | |
| with: | |
| path: ./ | |
| formatting: | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Check formatting | |
| uses: FreeRTOS/CI-CD-Github-Actions/formatting@main | |
| with: | |
| path: ./ | |
| git-secrets: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Checkout awslabs/git-secrets | |
| uses: actions/checkout@v4 | |
| 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@v4 | |
| with: | |
| submodules: "recursive" | |
| - name: Install Python3 | |
| uses: actions/setup-python@v5 | |
| 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@v4 | |
| - name: Check Links | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| uses: FreeRTOS/CI-CD-Github-Actions/link-verifier@main | |
| verify-manifest: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| fetch-depth: 0 | |
| # At time of writing the gitmodules are set not to pull | |
| # Even when using fetch submodules. Need to run this command | |
| # To force it to grab them. | |
| - name: Perform Recursive Clone | |
| shell: bash | |
| run: git submodule update --checkout --init --recursive | |
| - 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_64-core | |
| steps: | |
| - name: Set up CBMC runner | |
| uses: FreeRTOS/CI-CD-Github-Actions/set_up_cbmc_runner@main | |
| with: | |
| cbmc_version: "5.61.0" | |
| cbmc_viewer_version: "3.5" | |
| kissat_tag: latest | |
| - run: | | |
| git submodule update --init --checkout --recursive | |
| sudo apt-get update | |
| sudo apt-get install --yes --no-install-recommends gcc-multilib build-essential | |
| - name: Run CBMC | |
| uses: FreeRTOS/CI-CD-Github-Actions/run_cbmc@main | |
| with: | |
| proofs_dir: test/cbmc/proofs |