Skip to content

Update OpenSSF badge link in README.md - #436

Closed
AlanGraham wants to merge 1 commit into
apache:masterfrom
AlanGraham:patch-1
Closed

Update OpenSSF badge link in README.md#436
AlanGraham wants to merge 1 commit into
apache:masterfrom
AlanGraham:patch-1

Conversation

@AlanGraham

Copy link
Copy Markdown

OpenSSF have provided a way to link to a nicer page of your OpenSSF score. https://api.securityscorecards.dev/projects/github.com/apache/commons-validator -> https://scorecard.dev/viewer/?uri=github.com/apache/commons-validator

So rather than a json blob, the link can now go to a nicely formatted page which also links to information on some of the items on what is needed to improve the score.

Thanks for your contribution to Apache Commons! Your help is appreciated!

Before you push a pull request, review this list:

  • Read the contribution guidelines for this project.
  • Read the ASF Generative Tooling Guidance if you use Artificial Intelligence (AI).
  • I used AI to create any part of, or all of, this pull request. Which AI tool was used to create this pull request, and to what extent did it contribute?
  • Run a successful build using the default Maven goal with mvn; that's mvn on the command line by itself.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible, but it is a best practice.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body. Note that a maintainer may squash commits during the merge process.

OpenSSF have provided a way to link to a nicer page of your OpenSSF score. 
`https://api.securityscorecards.dev/projects/github.com/apache/commons-validator` -> `https://scorecard.dev/viewer/?uri=github.com/apache/commons-validator`

So rather than a json blob, the link can now go to a nicely formatted page which also links to information on some of the items on what is needed to improve the score.
@AlanGraham

Copy link
Copy Markdown
Author

I was working through a list of the dependencies in our app to encourage some of our engineers to submit PRs to some of the libraries we depend on, and noticed this badge. Having recently worked on it for a project I was curious about your scores and realised the link didn't go to the nicely formatted page.

As for scoring, if you sign up to even work on the "passing" badge you gain points, even if you don't complete it. I'm sure it would be pretty simple for you to pass or score a high score for the passing level https://www.bestpractices.dev/en/criteria/0
The Token-Permissions one links to a security bot which can audit and raise PRs to write the appropriate permissions too
https://github.com/ossf/scorecard/blob/c395761df6afe1a69e476bc60a013a94bcbc153f/docs/checks.md#token-permissions

Just happy to see one of our dependencies has looked into this pretty cool tool too :).

@garydgregory

Copy link
Copy Markdown
Member

Hello @AlanGraham
The file is regenerated on every release by the commons-build-plugin Maven plugin, so editing it here will be temporary. If you want to change this, the plugin is the place to do it.

@garydgregory
garydgregory marked this pull request as draft September 7, 2026 11:13
@AlanGraham

Copy link
Copy Markdown
Author

Ah cool will take a look at that, was carrying on through list and see https://github.com/apache/commons-text/blob/master/README.md also has the issue, assume that would fix there too :).

@AlanGraham

Copy link
Copy Markdown
Author

Created apache/commons-build-plugin#425

@garydgregory

Copy link
Copy Markdown
Member

Closing in favor of apache/commons-build-plugin#425

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.

2 participants