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.

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

Add OpenSSF Scorecards to impove the security posture #93

Merged
merged 3 commits into from
Apr 23, 2022

Conversation

flyfishzy
Copy link
Contributor

What is Scorecards?

Scorecards is an Open Source Security Fundation porject.

Scorecards is an automated tool that assesses a number of important heuristics ("checks") associated with software security and assigns each check a score of 0-10. You can use these scores to understand specific areas to improve in order to strengthen the security posture of your project.
https://github.com/ossf/scorecard

Troubleshooting

In order to make Scorecards works correctly, a Read-only Access Token needs to be added to the project.
You can reference https://github.com/ossf/scorecard-action#authentication

@zherczeg
Copy link
Collaborator

What is the benefit of this? It seems it gives you numbers which you can compare between projects. I don't have good experiences with such numbers they are often confusing.

@flyfishzy
Copy link
Contributor Author

flyfishzy commented Mar 29, 2022

It can help improve security posture, eg. Static Application Security Testing (SAST),CI-Tests,Branch-Protection and so on.
This PR add two github actions which are automatically triggered whenever there is a code commit.
It's not just numbers, it will also give us security advice and best practices.
image

@PhilipHazel PhilipHazel merged commit 77ce1ff into PCRE2Project:master Apr 23, 2022
@PhilipHazel
Copy link
Collaborator

I'm pleased to note that running this check found only one issue: a grumble about a potential integer overflow in pcre2test which in practice could never happen. Nevertheless, it is always helpful to have more checking going on, so I have merged this PR. As well as fixing the reported issue, this did get me to add some other small related tidies to pcre2test.

@PhilipHazel
Copy link
Collaborator

Spoke too soon ... there seems to be a problem with running the workflow.

@flyfishzy
Copy link
Contributor Author

It looks like the scorecards analysis run failed.
In order to make Scorecards works correctly, a Read-only Access Token needs to be added to the project.
You can reference https://github.com/ossf/scorecard-action#authentication

@PhilipHazel
Copy link
Collaborator

I believe I have sorted this out. The action has run clean.

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.

3 participants