Skip to content

feat: add OpenSSF badge #1823

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.

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

Merged
merged 6 commits into from
May 25, 2025
Merged

feat: add OpenSSF badge #1823

merged 6 commits into from
May 25, 2025

Conversation

maxday
Copy link
Member

@maxday maxday commented May 21, 2025

Hi team,

The clomonitor.io score for this repo is a bit low, one item that is missing is the OpenSSF badge
(source: https://clomonitor.io/projects/cncf/open-telemetry#opentelemetry-lambda)
Screenshot 2025-05-21 at 11 16 27 PM

This PR displays the badge on README

The clomonitor metric is reported on the CNCF website: https://landscape.cncf.io/?item=observability-and-analysis--observability--opentelemetry so this PR will help to raise the overall score.

Let me know if you have any questions of course!

@maxday maxday requested a review from a team as a code owner May 21, 2025 22:23
@maxday maxday changed the title feat: add OpenSSF scorecard support and badge feat: add OpenSSF badge May 21, 2025
@pragmaticivan
Copy link
Member

pragmaticivan commented May 23, 2025

Screenshot 2025-05-23 at 7 42 06 AM
Is there a way to change the design? This is the only badge out of pattern.

@maxday
Copy link
Member Author

maxday commented May 23, 2025

I guess it is indeed possible using https://shields.io/badges but the documented check mention a regex against the api.scorecard domain https://clomonitor.io/docs/topics/checks/#openssf-scorecard-badge. We could of course bypass to cheat and add it as a comment but I don't think that's a good idea. Let me know!

@pragmaticivan
Copy link
Member

I don't have much say on that one, but my suggestion is that we bypass to make it similar ot change the other ones to match this new one.

I will defer to @serkan-ozal @tylerbenson

@tylerbenson
Copy link
Member

Can you share some links to other OpenTelemetry repos that are already using this?

@serkan-ozal
Copy link
Contributor

They are redirecting to the img.shields.io along with given path and query parameters. So adding style=for-the-badge query param to the link is enough: https://api.scorecard.dev/projects/github.com/open-telemetry/opentelemetry-lambda/badge?style=for-the-badge

@maxday
Copy link
Member Author

maxday commented May 25, 2025

oh nice! Let me update the PR then!

@maxday
Copy link
Member Author

maxday commented May 25, 2025

This indeed looks better now!
Screenshot 2025-05-25 at 3 14 26 PM

Copy link
Member

@pragmaticivan pragmaticivan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thx for accommodating the style changes!

@serkan-ozal serkan-ozal merged commit 5b45bed into open-telemetry:main May 25, 2025
11 checks passed
@maxday maxday mentioned this pull request May 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants