This extends on submission by @tomasbjerre in #5040 by moving the PMD and Spotbugs plugin execution to a separate profile static-analysis
. This keeps CheckStyle in the default build because it added a very minimal amount of time to execution.
Once merged, I'd like to extend the Sonar CI GitHub Action to be a static analysis action which caches the xml reports generated by these plugins as build artifacts. This will give us SonarCloud as a means for evaluating the static analysis, and allow for contributors to download the *.xml
reports from the action. Once the GitHub action is updated, we can also close #33 (closed) as well.
Core contributors may run static analysis with:
mvn -Pstatic-analysis install
The analysis is separated from default functionality to reduce impact to community contributions. SpotBugs/PMD may add a non-trivial amount of time to builds on some machines.
cc @OpenAPITools/generator-core-team
Closes #5040
PR checklist
-
Read the contribution guidelines. -
If contributing template-only or documentation-only changes which will change sample output, build the project before. -
Run the shell script(s) under ./bin/
(or Windows batch scripts under.\bin\windows
) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run./bin/{LANG}-petstore.sh
,./bin/openapi3/{LANG}-petstore.sh
if updating the code or mustache templates for a language ({LANG}
) (e.g. php, ruby, python, etc). -
File the PR against the correct branch: master
,4.3.x
,5.0.x
. Default:master
. -
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.