modern-java-practices icon indicating copy to clipboard operation
modern-java-practices copied to clipboard

Improve project badges

Open jwlibby opened this issue 1 year ago • 0 comments

Related cards: #586, #457. Focus of this card narrowed to just badges.

Create a dashboard to provide a window into the current state of the codebase. It should have links into various reports. Examples: NOTE: this list is not exhaustive. Brainstorm to come up with a more definitive list in the analysis stage

  • [ ] Pit Test
  • [ ] Checkstyle
  • [ ] Spotbugs
  • [x] Unit test/coverage
  • [ ] Dependency check
  • [x] Snyk security
  • [ ] PMD (bugs)/CPD (copy/paste detector)
  • [ ] CodeQL

Note that the Maven CI build copies the JaCoCo HTML report as an artifact for us to use in building the Coverage badge in README.md, and GH actions shows this on the action result page: https://github.com/binkley/modern-java-practices/actions/runs/9973214437. I'm experimenting with Gradle doing the same in the project, and am using a side project to explore what GH actions shows.

Refs

  • https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary (though does not provide a front page dashboard, rather one for each action Run)
  • Web search on "github actions dashboard" to see existing landscape for automation through the CI build

jwlibby avatar May 29 '24 13:05 jwlibby