Skip to content

Commit 5aff56d

Browse files
mossmannmossmann
authored
Merge pull request #1717 from greatscottgadgets/antoinevg/ci-headers-check
Add an includes-check CI workflow
2 parents 9617217 + 8018feb commit 5aff56d

3 files changed

Lines changed: 141 additions & 0 deletions

File tree

‎.github/workflows/includes-check.yml‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: Check includes
2+
on: [push, pull_request]
3+
4+
defaults:
5+
run:
6+
shell: bash
7+
8+
jobs:
9+
includes-check:
10+
runs-on: ubuntu-latest
11+
container:
12+
image: "debian:13"
13+
options: --user 0
14+
strategy:
15+
matrix:
16+
board: ['HACKRF_ONE', 'JAWBREAKER', 'RAD1O', 'PRALINE']
17+
cmake: ['3.10.0', 'latest']
18+
19+
# Don't cancel all builds when one fails
20+
fail-fast: false
21+
22+
steps:
23+
24+
- name: Make it work on debian
25+
run: |
26+
apt update
27+
apt install -y git python3 python3-pip python3-venv nodejs
28+
# actions/checkout insists on putting the checkout in the
29+
# working directory rather than ${{ github.workspace }}.
30+
#
31+
# This may just be because the 'runner' user does not exist
32+
# in the docker image at startup.
33+
#
34+
# also see: https://github.com/actions/runner/issues/878
35+
useradd -ms /bin/bash runner
36+
ln -s /__w /home/runner/work
37+
38+
- name: Checkout repository
39+
uses: actions/checkout@v6
40+
with:
41+
submodules: true
42+
43+
- name: Setup cmake
44+
uses: jwlawson/actions-setup-cmake@v2
45+
with:
46+
cmake-version: ${{ matrix.cmake }}
47+
48+
- name: Install Arm GNU Toolchain
49+
uses: carlosperate/arm-none-eabi-gcc-action@v1
50+
51+
- name: Install dependencies
52+
run: |
53+
python3 -m venv environment && source environment/bin/activate
54+
python3 -m pip install PyYAML
55+
apt install -y iwyu
56+
iwyu --version
57+
58+
- name: Build libopencm3
59+
working-directory: ${{github.workspace}}/firmware/libopencm3/
60+
run: |
61+
source ../../environment/bin/activate
62+
make
63+
64+
- name: Create Build Environment
65+
run: cmake -E make_directory ${{github.workspace}}/firmware/build
66+
67+
- name: Configure CMake
68+
working-directory: ${{github.workspace}}/firmware/build
69+
run: cmake ${{github.workspace}}/firmware/ -DCMAKE_BUILD_TYPE=Release -DBOARD=${{ matrix.board }} -DCHECK_INCLUDES=1
70+
71+
- name: Build
72+
working-directory: ${{github.workspace}}/firmware/build
73+
run: |
74+
source ../../environment/bin/activate
75+
output="$(cmake --build . --config Release 2>&1)"
76+
while IFS= read -r line
77+
do
78+
if [[ "${line}" == "Warning: include-what-you-use"* ]]; then
79+
exit_code=1
80+
dump=1
81+
echo
82+
elif [[ "${line}" == "---" ]]; then
83+
dump=0
84+
echo
85+
fi
86+
if [[ ${dump} == "1" ]]; then
87+
echo "${line}"
88+
fi
89+
done <<< ${output}
90+
if [[ ${exit_code} == "1" ]]; then
91+
echo "Includes check failed for board target: ${{ matrix.board }}"
92+
else
93+
echo "Includes check succeeded for board target: ${{ matrix.board }}"
94+
fi
95+
echo $(include-what-you-use --version)
96+
exit ${exit_code}

‎firmware/CMakeLists.txt‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,17 @@
2020

2121
# Top directory CMake project for HackRF firmware
2222

23+
option(CHECK_INCLUDES
24+
"Check firmware sources for unused includes and transitive dependencies. (Requires iwyu)" OFF)
25+
2326
cmake_minimum_required(VERSION 3.10.0)
2427
set(CMAKE_TOOLCHAIN_FILE toolchain-arm-cortex-m.cmake)
2528

2629
project (hackrf_firmware_all C)
2730

31+
if(CHECK_INCLUDES)
32+
include(include-what-you-use.cmake)
33+
endif()
34+
2835
add_subdirectory(blinky)
2936
add_subdirectory(hackrf_usb)

‎firmware/include-what-you-use.cmake‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Copyright 2026 Great Scott Gadgets <info@greatscottgadgets.com>
2+
#
3+
# This file is part of HackRF.
4+
#
5+
# This program is free software; you can redistribute it and/or modify
6+
# it under the terms of the GNU General Public License as published by
7+
# the Free Software Foundation; either version 2, or (at your option)
8+
# any later version.
9+
#
10+
# This program is distributed in the hope that it will be useful,
11+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
# GNU General Public License for more details.
14+
#
15+
# You should have received a copy of the GNU General Public License
16+
# along with this program; see the file COPYING. If not, write to
17+
# the Free Software Foundation, Inc., 51 Franklin Street,
18+
# Boston, MA 02110-1301, USA.
19+
#
20+
21+
cmake_minimum_required(VERSION 3.10.0)
22+
23+
find_program(IWYU_COMMAND NAMES include-what-you-use)
24+
if(NOT IWYU_COMMAND)
25+
message(FATAL_ERROR "Could not find the include-what-you-use executable.")
26+
endif()
27+
28+
# include-what-you-use arguments:
29+
#
30+
# --no_fwd_decls - Disable forward declaration suggestions.
31+
# --mapping_file - Specify mapping files for excluding suggestions.
32+
#
33+
list(APPEND IWYU_COMMAND
34+
-Xiwyu --no_fwd_decls
35+
-Xiwyu --mapping_file=${CMAKE_SOURCE_DIR}/libopencm3.imp)
36+
37+
set(CMAKE_C_INCLUDE_WHAT_YOU_USE ${IWYU_COMMAND})
38+
set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE ${IWYU_COMMAND})

0 commit comments

Comments
 (0)