Merge pull request #224 from BlueAndi/bugfix/customOption #1398
This file contains hidden or 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: main | |
| concurrency: | |
| group: ci-${{ github.ref }} | |
| cancel-in-progress: true | |
| # Controls when this workflow runs. | |
| on: | |
| push: | |
| # Runs on every push. | |
| branches: [ '**' ] | |
| release: | |
| # Runs when a release, pre-release, or draft of a release is published. | |
| types: [ published ] | |
| # Can be run manually from the Actions tab. | |
| workflow_dispatch: | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel. | |
| jobs: | |
| # Show some useful information. | |
| intro: | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - run: echo "The job was automatically triggered by a ${{ github.event_name }} event." | |
| - run: echo "The name of the branch is ${{ github.ref }} and the repository is ${{ github.repository }}." | |
| # Build all targets and perform static checks on them. | |
| build: | |
| runs-on: ubuntu-24.04 | |
| needs: intro | |
| strategy: | |
| matrix: | |
| environment: ["ConvoyLeaderTarget", | |
| "ConvoyFollowerTarget", | |
| "LineFollowerTarget", | |
| "RemoteControlTarget", | |
| "SensorFusionTarget", | |
| "TurtleTarget"] | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: '3.12.3' | |
| cache: 'pip' | |
| cache-dependency-path: .github/workflows/requirements.txt | |
| - name: Install dependencies | |
| run: | | |
| pip install -r .github/workflows/requirements.txt | |
| - name: Cache PlatformIO | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ~/.platformio/.cache | |
| ~/.platformio/packages | |
| ~/.platformio/platforms | |
| key: ${{ runner.os }}-pio-${{ hashFiles('platformio*.ini') }} | |
| # Run cppcheck and clang-tidy. | |
| - name: Perform static checks on ${{ matrix.environment }} | |
| run: platformio check --environment ${{ matrix.environment }} # --fail-on-defect=medium --fail-on-defect=high | |
| - name: Compile ${{ matrix.environment }} firmware | |
| run: platformio run --environment ${{ matrix.environment }} | |
| # Perform static checks on test. | |
| check: | |
| runs-on: ubuntu-24.04 | |
| needs: intro | |
| strategy: | |
| matrix: | |
| environment: ["Test"] | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: '3.12.3' | |
| cache: 'pip' | |
| cache-dependency-path: .github/workflows/requirements.txt | |
| - name: Install dependencies | |
| run: | | |
| pip install -r .github/workflows/requirements.txt | |
| - name: Cache PlatformIO | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ~/.platformio/.cache | |
| ~/.platformio/packages | |
| ~/.platformio/platforms | |
| key: ${{ runner.os }}-pio-${{ hashFiles('platformio*.ini') }} | |
| # Run cppcheck and clang-tidy. | |
| - name: Perform static checks on ${{ matrix.environment }} | |
| run: platformio check --environment ${{ matrix.environment }} # --fail-on-defect=medium --fail-on-defect=high | |
| # Perform tests. | |
| test: | |
| runs-on: ubuntu-24.04 | |
| needs: intro | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: '3.12.3' | |
| cache: 'pip' | |
| cache-dependency-path: .github/workflows/requirements.txt | |
| - name: Install dependencies | |
| run: | | |
| pip install -r .github/workflows/requirements.txt | |
| - name: Cache PlatformIO | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ~/.platformio/.cache | |
| ~/.platformio/packages | |
| ~/.platformio/platforms | |
| key: ${{ runner.os }}-pio-${{ hashFiles('platformio*.ini') }} | |
| - name: Run tests on native environment | |
| run: platformio test --environment Test -vvv | |
| # Build documentation. | |
| doc: | |
| runs-on: ubuntu-24.04 | |
| needs: intro | |
| strategy: | |
| matrix: | |
| environment: ["ConvoyLeaderTarget", | |
| "ConvoyFollowerTarget", | |
| "ConvoyLeaderSim", | |
| "ConvoyFollowerSim", | |
| "LineFollowerTarget", | |
| "LineFollowerSim", | |
| "RemoteControlTarget", | |
| "RemoteControlSim", | |
| "SensorFusionTarget", | |
| "SensorFusionSim", | |
| "TurtleTarget", | |
| "TurtleSim"] | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up graphviz | |
| uses: ts-graphviz/setup-graphviz@v2 | |
| - name: Set up doxygen and generate documentation for ${{ matrix.environment }} | |
| uses: mattnotmitt/doxygen-action@v1.12.0 | |
| with: | |
| working-directory: './doc/doxygen' | |
| doxyfile-path: './${{ matrix.environment }}Doxyfile' | |
| - name: Print doxygen warnings | |
| if: ${{ failure() }} | |
| run: cat ./doc/doxygen/doxygen_warnings.txt |