Add check-project workflow #1746
Conversation
Create a workflow for analyzing Java projects via PR versions of Spotbugs. Baseline diff and time measurement features are added to monitor the impact of PRs (result set changes or possible regressions). Open-source projects spotbugs, matsim and jenkins are added as test subjects.
|
Hi,
With these in place I would like to propose this new PR, which consists of only 2 workflow files. If you have any ideas or suggestions as to how to improve this differential CI, please feel free to share! |
| - name: Cache analyzed Spotbugs | ||
| uses: actions/cache@v2 | ||
| with: | ||
| path: spotbugs-4.4.1.jar |
There was a problem hiding this comment.
Could you move the version infos to variables, so it's easier to modify them in the future? (Not only for spotbugs, but the other projects as well.)
| const resultDiff = fs.readFileSync(`${projectDir}/result_diff`) | ||
|
|
||
| const body = | ||
| `${projectName} |
There was a problem hiding this comment.
IMO it would be easier to understand if the comments contained whole sentences, instead of only the bare minimal info. Also, it would be a bit more informative, if it contained not only the name of the tested project, but a link to the exact source and some version info (or commit hash).
This line could be e.g. Testing/Running this PR on ${projectName} (${projectUrl}) version ${projectVersion}..
| `${projectName} | ||
| baseline time: ${baselineTime}s | ||
| new time: ${newTime}s | ||
| results diff: ${resultDiff ? '\n```' + resultDiff + '```' : '-'} |
There was a problem hiding this comment.
If there are no differences, instead of an empty codeblock, there could a No differences were found. or The results are identical. or some other similar string.
|
|
||
| steps: | ||
| - name: Checkout PR | ||
| uses: actions/checkout@v2 |
| java-version: '17.0.x' | ||
|
|
||
| - name: Cache Gradle | ||
| uses: actions/cache@v2 |
| persist-credentials: false | ||
|
|
||
| - name: Set up JDK 17 | ||
| uses: actions/setup-java@v1 |
Create a workflow for analyzing Java projects via PR versions of
Spotbugs. Baseline diff and time measurement features are added to
monitor the impact of PRs (result set changes or possible regressions).
Open-source projects spotbugs, matsim and jenkins are added as test
subjects.
Make sure these boxes are checked before submitting your PR -- thank you!
CHANGELOG.mdif you have changed SpotBugs code