| commit | 1832ffa3eef0485169caadf03b012fe614de31c1 | [log] [tgz] |
|---|---|---|
| author | Andrew Jeffery <andrew@codeconstruct.com.au> | Thu Jun 26 10:31:09 2025 +0930 |
| committer | Andrew Jeffery <andrew@codeconstruct.com.au> | Thu Jun 26 10:43:24 2025 +0930 |
| tree | 4a22f35c86712ea9341ad7dc348387571ad81985 | |
| parent | a1cbd4041f94193e1c43e767156c8a2dd117b99d [diff] |
format-code: Print tool versions and describe version policy
The updated output improves our ability to spot differences in tools
across CI worker containers:
```
$ ./openbmc-build-scripts/scripts/format-code.sh ./libpldm/origin/
Formatting code under .../libpldm/origin
markdownlint: cannot find .markdownlint.yaml; using .../openbmc-build-scripts/config/markdownlint.yaml
prettier: cannot find .prettierrc.yaml; using .../openbmc-build-scripts/config/prettierrc.yaml
Running commit_gitlint (0.19.1)
Running commit_spelling (codespell: 2.4.1)
codespell-dictionary - misspelling count >> 0
generic-dictionary - misspelling count >> 0
Running beautysh (6.2.1)
Running black (black, 25.1.0 (compiled: yes))
All done! ✨ 🍰 ✨
2 files left unchanged.
Running clang_format (Ubuntu clang-format version 20.1.7 (++20250613062657+6146a88f6049-1~exp1~20250613062712.130))
Running clang_tidy (openbmc-build-scripts: effec66f389b614089f46e1ae5b41ffa05c3e817)
Running flake8 (7.2.0 (mccabe: 0.7.0, pycodestyle: 2.13.0, pyflakes: 3.3.2) CPython 3.12.7 on Linux)
Running isort (6.0.1)
Running markdownlint (0.45.0)
Running meson (1.7.0)
Running prettier (3.5.3)
...
Running shellcheck (0.10.0)
Result differences...
Format: PASSED
```
Change-Id: I1a14b5ba765a794f2aec37302fc35173a13ba4e7
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>
Build script for CI jobs in Jenkins.
Formatting linters sometimes change stylistic output across releases. Separately, some linters are not version-pinned in the CI container, as pinning would drive either frequent maintenance with upgrades or stagnation of the code-base against older versions.
The combination may result in inconsistent formatting opinions across CI worker nodes[^1].
If you see such behaviour consider changing the thing to force a container refresh.
[^1]: The collection of container builds across all worker nodes may not hold a consistent set of tool versions despite being built from the same specification: The inconsistencies emerge from the cadence of upstream tool package updates beating against the cadence of container rebuilds on the worker nodes.