docs: update usage section #85
Workflow file for this run
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 | |
| on: [push, pull_request] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-22.04 | |
| name: build | |
| steps: | |
| - name: Checkout repo | |
| uses: actions/checkout@v3 | |
| - name: Set up environment | |
| # use the local action specified in action.yml | |
| uses: ./.github/workflows | |
| - name: Create debug build | |
| run: make clean && make debug | |
| - name: Create release build | |
| run: make clean && make release | |
| test: | |
| runs-on: ubuntu-22.04 | |
| name: test | |
| needs: build | |
| steps: | |
| - name: Checkout repo | |
| uses: actions/checkout@v3 | |
| - name: Set up environment | |
| # use the local action specified in action.yml | |
| uses: ./.github/workflows | |
| - name: Run unit tests | |
| run: make tests | |
| - name: Check memory management bugs with Valgrind | |
| run: make valgrind | |
| - name: Run CLI tests on release build | |
| run: chmod +x ./cli_test.sh && ./cli_test.sh -r | |
| lint: | |
| if: github.ref == 'refs/heads/main' || github.base_ref == 'main' | |
| name: lint | |
| runs-on: ubuntu-22.04 | |
| needs: build | |
| steps: | |
| - name: Checkout repo | |
| uses: actions/checkout@v3 | |
| - name: Install cmocka | |
| # clang-tidy requires code to be compilable | |
| run: | | |
| SCRIPT='./.github/scripts/install_cmocka.sh' | |
| chmod +x "$SCRIPT" && "$SCRIPT" | |
| - name: Check coding styles | |
| run: make fmt FMTFLAGS='--dry-run --Werror' | |
| - name: Check naming conventions & bug-proneness | |
| run: make tidy |