sca: add ECLAIR configuration for main Coding Guidelines rules and a ECLAIR workflow #90345
Conversation
|
Hello @LucaCiucci, and thank you very much for your first pull request to the Zephyr project! |
Various improvements to the integration files in order to obtain correct static analysis results: - variable `ECLAIR_WORKSPACE' is set to the build output directory, to allow multiple ECLAIR analyses running in parallel on the same machine without conflicts; - fix the evaluation order of rulesets to allow a user-provided ruleset to be selected without a cmake options file that undefines other ECLAIR_RULESET_* variables; - add a clean-only frame to initiate the analysis and a project frame to end it. Signed-off-by: Nicola Vetrini <[email protected]>
This check prevents misconfigurations where more than one ruleset is selected, ensuring that the analysis is not silently performed with an unintended configuration. Signed-off-by: Luca Ciucci <[email protected]>
Added the main rules from the conding guidelines selection listed in /doc/contribute/coding_guidelines/index.rst to the zephyr_guidelines configuration. Signed-off-by: Luca Ciucci <[email protected]>
Added prerequisites section, fixed some typos and added ECLAIR_RULESET_ZEPHYR_GUIDELINES option. Also updated dead doc string links in ECLAIR configuration files. Signed-off-by: Luca Ciucci <[email protected]>
Introduce ECLAIR_SUMMARY_HTML and ECLAIR_FULL_HTML CMake options to enable the generation of HTML reports. Signed-off-by: Luca Ciucci <[email protected]>
| @@ -0,0 +1,59 @@ | |||
| name: "Eclair Zephyr Guideline Selection Check" | |||
There was a problem hiding this comment.
need to drop this from the PR, we will have to add the worflow later. this workflow will not work as is.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
Dropped d736c60 ( |
|
github-actions
bot
requested review from
57300,
carlescufi,
jeremybettis,
kartben,
nordicjm and
tejlmand
Add a "zephyr_guidelines" selection that reflects the main Conding Guidelines list.
This PR also introduces a workflow (
eclair_guidelines_check.yaml) to use the "first_analysis" selection on a self-hosted runner.The workflow can be easily adapted to other selections, for example:
run: | source .venv/bin/activate west build -b nrf52dk/nrf52805 samples/basic/blinky -- \ - -DZEPHYR_SCA_VARIANT=eclair -DECLAIR_RULESET_FIRST_ANALYSIS=ON \ + -DZEPHYR_SCA_VARIANT=eclair -DECLAIR_RULESET_ZEPHYR_GUIDELINES=ON \ + -DECLAIR_RULESET_FIRST_ANALYSIS=OFF \ -DECLAIR_SUMMARY_HTML=ON \ -DECLAIR_REPORTS_SARIF=ONThis PR also introduces some enhancements to
cmake/sca/eclair/sca.cmakeand some fixes to the documentation.Signed-off-by: Luca Ciucci [email protected]