Skip to content

chore(format): fail make format on clang-format version mismatch #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AlexKlimaj wants to merge 1 commit into
base: ark-release
Choose a base branch
from
Open

chore(format): fail make format on clang-format version mismatch #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ make size-check-ark # ARK F051 flash/RAM gate (HWCI+embed worst case, then re

Style is **PX4-inspired** via clang-format (Linux braces, tab indent width 8, `int *p`, column 140) — same `make format` / `check_format` workflow as PX4, not astyle itself. See `.clang-format`.

`make format` skips vendor trees (`Mcu/**/Drivers`, CMSIS, DroneCAN `dsdl_generated` / `libcanard`). Install clang-format with `pip install --user 'clang-format==22.1.5'` (version pinned to match CI) or your distro package.
`make format` skips vendor trees (`Mcu/**/Drivers`, CMSIS, DroneCAN `dsdl_generated` / `libcanard`). Install the **CI-pinned** clang-format with `pip install --user 'clang-format==22.1.5'` and put `~/.local/bin` first on PATH. Distro packages of a different version will fail `make format` / `check_format` (see `scripts/format.sh`).

---

Expand Down
30 changes: 26 additions & 4 deletions scripts/format.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,36 @@ for arg in "$@"; do
esac
done

# Keep in lockstep with .github/workflows/static-analysis.yml
# (python3 -m pip install --user 'clang-format==22.1.5').
PINNED_CLANG_FORMAT=22.1.5

if ! command -v clang-format >/dev/null 2>&1; then
echo "clang-format not found on PATH." >&2
echo "Install one of:" >&2
echo " pip install --user 'clang-format==22.1.5'" >&2
echo " sudo apt-get install clang-format" >&2
echo "Install: pip install --user 'clang-format==${PINNED_CLANG_FORMAT}'" >&2
echo "and put ~/.local/bin first on PATH." >&2
exit 1
fi

# A different local version + `make format` (AGENTS.md) is how we got a
# whitespace-only commit that CI then rejected. Fail here instead.
cf_ver_line="$(clang-format --version | head -1)"
cf_ver="$(printf '%s\n' "$cf_ver_line" | sed -n 's/.*[[:space:]]\([0-9][0-9]*\.[0-9][0-9]*\.[0-9][0-9]*\).*/\1/p')"
if [[ "${CLANG_FORMAT_SKIP_VERSION:-}" != "1" ]]; then
if [[ -z "$cf_ver" ]]; then
echo "Could not parse clang-format version from: $cf_ver_line" >&2
echo "Expected ${PINNED_CLANG_FORMAT} (CI pin)." >&2
exit 1
fi
if [[ "$cf_ver" != "$PINNED_CLANG_FORMAT" ]]; then
echo "clang-format ${cf_ver} does not match CI pin ${PINNED_CLANG_FORMAT}." >&2
echo "Install: pip install --user 'clang-format==${PINNED_CLANG_FORMAT}'" >&2
echo "and ensure that binary is first on PATH." >&2
echo "Override (not for PRs): CLANG_FORMAT_SKIP_VERSION=1" >&2
exit 1
fi
fi

# Collect sources under application and MCU trees, pruning third-party /
# generated paths. Keep this list in sync with .clang-format-ignore.
collect_all() {
Expand Down Expand Up @@ -91,7 +113,7 @@ if [[ ${#FILES[@]} -eq 0 ]]; then
exit 0
fi

echo "clang-format $(clang-format --version | head -1)"
echo "clang-format ${cf_ver_line}"
echo "Files: ${#FILES[@]} mode: $([[ $CHECK -eq 1 ]] && echo check || echo fix)"

# Canonical form = clang-format, then drop trailing whitespace (clang-format
Expand Down
Loading