DroidControlShip/.github/workflows/main.yml at develop · BlueAndi/DroidControlShip · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
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