Add additional quality badges to README #584

Stephan202 · 2023-04-16T09:33:13Z

Suggested commit message:

Add additional quality badges to README (#584)

Check this link to see what it would look like on the home page. I considered other orders/formatting, but none looked obviously better. Let's merge #575 before we merge this PR.

W.r.t. whether to show multiple SonarCloud badges: I opted for "yes", as it does concisely summarize the various dimensions along which we achieved high quality.

github-actions · 2023-04-16T09:34:53Z

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

github-actions · 2023-04-16T09:51:49Z

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

github-actions · 2023-04-16T09:52:03Z

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

github-actions · 2023-04-16T09:52:21Z

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

github-actions · 2023-04-16T09:52:57Z

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

japborst

I think formatting is fine and separate badges make sense. Was there any particular reasoning for the ordering?

japborst · 2023-04-17T05:23:48Z

README.md

+[openssf-best-practices-badge]: https://bestpractices.coreinfrastructure.org/projects/7199/badge
+[openssf-best-practices-checklist]: https://bestpractices.coreinfrastructure.org/projects/7199
+[openssf-scorecard-badge]: https://img.shields.io/ossf-scorecard/github.com/PicnicSupermarket/error-prone-support?label=openssf%20scorecard
+[openssf-scorecard-report]: https://api.securityscorecards.dev/projects/github.com/PicnicSupermarket/error-prone-support


Is there a better link that has a UI? As this returns JSON. (Have personally not seen this on other projects, so not sure what's common here)

I was wondering the same thing, but modeled this after what the authors do themselves. It looks like so far there was no effort to build a proper UI. (A subset of the findings are reported here, but that view is not specific to OpenSSF Scorecard, and doesn't seem to be publicly accessible.)

In the launch article, they mention tensorflow and flutter. Both have the badge, where tensorflow does the same as here (link to the api), whereas flutter links to https://deps.dev/project/github/flutter%2Fflutter. This is actually a nice overview!

However, searching for PicnicSupermarket/error-prone-support - although found - leads to https://deps.dev/project/github/picnicsupermarket%2Ferror-prone-support, with no info 😕

Ah, interesting! The Flutter page says:

Project metadata as of April 15, 2023.

Maybe it doesn't regenerate very frequently. Since we should anyway finalize #575 first, let's see what happens over the next ~48 hours 👀

Still 404... 🤷

That's unfortunate. Hoped that it would've worked in the mean time. Will approve.

Stephan202

Was there any particular reasoning for the ordering?

"A feeling" / salience. But none that I can clearly articulate 😬.

Stephan202 · 2023-04-17T06:13:51Z

README.md

+[openssf-best-practices-badge]: https://bestpractices.coreinfrastructure.org/projects/7199/badge
+[openssf-best-practices-checklist]: https://bestpractices.coreinfrastructure.org/projects/7199
+[openssf-scorecard-badge]: https://img.shields.io/ossf-scorecard/github.com/PicnicSupermarket/error-prone-support?label=openssf%20scorecard
+[openssf-scorecard-report]: https://api.securityscorecards.dev/projects/github.com/PicnicSupermarket/error-prone-support


I was wondering the same thing, but modeled this after what the authors do themselves. It looks like so far there was no effort to build a proper UI. (A subset of the findings are reported here, but that view is not specific to OpenSSF Scorecard, and doesn't seem to be publicly accessible.)

github-actions · 2023-04-22T14:54:10Z

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

rickie

Looks good! Made some suggestions.

rickie · 2023-04-22T14:55:00Z

README.md

+[sonarcloud-security-badge]: https://sonarcloud.io/api/project_badges/measure?project=PicnicSupermarket_error-prone-support&metric=security_rating
+[sonarcloud-security-master]: https://sonarcloud.io/component_measures?id=PicnicSupermarket_error-prone-support&metric=security_rating
+[sonarcloud-tech-debt-badge]: https://sonarcloud.io/api/project_badges/measure?project=PicnicSupermarket_error-prone-support&metric=sqale_index
+[sonarcloud-tech-debt-master]: https://sonarcloud.io/component_measures?id=PicnicSupermarket_error-prone-support&metric=sqale_index


We write it out for the sonar things above, so let's write "technical debt", WDYT?

github-actions · 2023-04-22T14:57:04Z

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Stephan202

@japborst do you approve? Then we can merge it once #575 is done.

Stephan202 · 2023-04-22T15:38:43Z

README.md

+[openssf-best-practices-badge]: https://bestpractices.coreinfrastructure.org/projects/7199/badge
+[openssf-best-practices-checklist]: https://bestpractices.coreinfrastructure.org/projects/7199
+[openssf-scorecard-badge]: https://img.shields.io/ossf-scorecard/github.com/PicnicSupermarket/error-prone-support?label=openssf%20scorecard
+[openssf-scorecard-report]: https://api.securityscorecards.dev/projects/github.com/PicnicSupermarket/error-prone-support


Still 404... 🤷

Stephan202 · 2023-04-25T06:36:57Z

Rebased; with #575 merged this PR is ready to go as well.

github-actions · 2023-04-25T06:37:58Z

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

sonarqubecloud · 2023-04-25T06:38:13Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

Stephan202 added this to the 0.10.0 milestone Apr 16, 2023

Stephan202 requested review from japborst and rickie April 16, 2023 09:33

Stephan202 force-pushed the sschroevers/more-badges branch 3 times, most recently from 7e3fb68 to d5ae35e Compare April 16, 2023 09:51

japborst reviewed Apr 17, 2023

View reviewed changes

Stephan202 commented Apr 17, 2023

View reviewed changes

rickie force-pushed the sschroevers/more-badges branch from d5ae35e to daf97f3 Compare April 22, 2023 14:52

rickie approved these changes Apr 22, 2023

View reviewed changes

rickie added the documentation A documentation update label Apr 22, 2023

Stephan202 commented Apr 22, 2023

View reviewed changes

japborst approved these changes Apr 23, 2023

View reviewed changes

Stephan202 and others added 4 commits April 25, 2023 08:36

Add additional quality badges to README

6894db5

Forgot one

afd7836

Typo

716479d

Write out tech debt

05019df

Stephan202 force-pushed the sschroevers/more-badges branch from 2d40161 to 05019df Compare April 25, 2023 06:36

rickie merged commit 2f2e7e7 into master Apr 25, 2023

rickie deleted the sschroevers/more-badges branch April 25, 2023 06:54

Add additional quality badges to README #584

Add additional quality badges to README #584

Uh oh!

Conversation

Stephan202 commented Apr 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Apr 16, 2023

Uh oh!

github-actions bot commented Apr 16, 2023

Uh oh!

github-actions bot commented Apr 16, 2023

Uh oh!

github-actions bot commented Apr 16, 2023

Uh oh!

github-actions bot commented Apr 16, 2023

Uh oh!

japborst left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Stephan202 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 22, 2023

Uh oh!

rickie left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 22, 2023

Uh oh!

Stephan202 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Stephan202 commented Apr 25, 2023

Uh oh!

github-actions bot commented Apr 25, 2023

Uh oh!

sonarqubecloud bot commented Apr 25, 2023

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

Stephan202 commented Apr 16, 2023 •

edited

Loading

Stephan202 left a comment •

edited

Loading