Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve project badges #506

Open
2 of 8 tasks
jwlibby opened this issue May 29, 2024 · 0 comments
Open
2 of 8 tasks

Improve project badges #506

jwlibby opened this issue May 29, 2024 · 0 comments
Assignees
@binkley
Labels
enhancement New feature or request reporting Things about badges, GH action pages, dashboards, etc

Comments

@jwlibby
Copy link
Collaborator

jwlibby commented May 29, 2024 •
edited
Loading

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
  • Unit test/coverage
  • Dependency check
  • 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
@jwlibby jwlibby added enhancement New feature or request epic So big in importance and breadth that it is EPIC! labels May 29, 2024
@binkley binkley mentioned this issue Jul 9, 2024
Closed
7 tasks
binkley added a commit that referenced this issue Jul 19, 2024
@binkley
For #506. Show Gradle test coverage
66d4186
binkley added a commit that referenced this issue Jul 19, 2024
@binkley
For #506. Fix typo
39dd998
@binkley binkley mentioned this issue Jul 19, 2024
Open
binkley added a commit that referenced this issue Jul 19, 2024
@binkley
For #506. Subtle
9108d95
binkley added a commit that referenced this issue Jul 19, 2024
@binkley
For #506. Full blown coverage badge with Gradle
08ad6a4 
Try out making a Gradle coverage badge. See if this allows the Run
report from GitHub actions to show nice HTML results like how the Maven
CI build does.
binkley added a commit that referenced this issue Jul 22, 2024
@binkley
For #506. Skip Gradle coverage badge
3a7ea1d 
This needs more research and experimenting. Get the build green again
before continuing with progress.
@binkley binkley changed the title Reporting dashboard Improve project reporting, dashboards, badges, etc Jul 22, 2024
@binkley binkley mentioned this issue Apr 15, 2024
Closed
4 tasks
@binkley binkley self-assigned this Aug 8, 2024
@binkley binkley changed the title Improve project reporting, dashboards, badges, etc Improve project badges Aug 8, 2024
@binkley binkley mentioned this issue Aug 8, 2024
Open
9 tasks
@binkley binkley added reporting Things about badges, GH action pages, dashboards, etc and removed epic So big in importance and breadth that it is EPIC! labels Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@binkley binkley

Labels
enhancement New feature or request reporting Things about badges, GH action pages, dashboards, etc
Projects
@binkley's Modern Build
Status: In progress
Milestone
No milestone
Development

No branches or pull requests
2 participants
@binkley @jwlibby