From 3a952d772840f825df8d15c6c62dc75dcc5c4ddb Mon Sep 17 00:00:00 2001 From: Diogo Teles Sant'Anna Date: Fri, 14 Jul 2023 13:48:50 -0300 Subject: [PATCH 1/3] docs(readme): suggest new score viewer on badge documentation Signed-off-by: Diogo Teles Sant'Anna --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 0201b8fbc00..7d5acee0e91 100644 --- a/README.md +++ b/README.md @@ -158,8 +158,7 @@ hard work. This badge also auto-updates for every change made to the repository. To include a badge on your project's repository, simply add the following markdown to your README: ``` -[![OpenSSF -Scorecard](https://api.securityscorecards.dev/projects/github.com/{owner}/{repo}/badge)](https://api.securityscorecards.dev/projects/github.com/{owner}/{repo}) +[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/{owner}/{repo}/badge)](https://securityscorecards.dev/viewer/?uri=github.com/{owner}/{repo}) ``` ### Scorecard Command Line Interface From 8e107db268172bd8e215c44d8c4804832e056d67 Mon Sep 17 00:00:00 2001 From: Diogo Teles Sant'Anna Date: Fri, 14 Jul 2023 14:18:25 -0300 Subject: [PATCH 2/3] docs(readme): add link to ossf blogpost about the badge Signed-off-by: Diogo Teles Sant'Anna --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d5acee0e91..534d468c396 100644 --- a/README.md +++ b/README.md @@ -154,7 +154,8 @@ in the Scorecard GitHub Action setting. Enabling [`publish_results: true`](https://github.com/ossf/scorecard-action/blob/dd5015aaf9688596b0e6d11e7f24fff566aa366b/action.yaml#L35) in Scorecard GitHub Actions also allows maintainers to display a Scorecard badge on their repository to show off their -hard work. This badge also auto-updates for every change made to the repository. +hard work. This badge also auto-updates for every change made to the repository. See more details on [this OSSF blogpost](https://openssf.org/blog/2022/09/08/show-off-your-security-score-announcing-scorecards-badges/). + To include a badge on your project's repository, simply add the following markdown to your README: ``` From 642f9ed79f427646fb1a4d7300ea14601d596994 Mon Sep 17 00:00:00 2001 From: Diogo Teles Sant'Anna Date: Fri, 14 Jul 2023 18:21:39 -0300 Subject: [PATCH 3/3] docs: update badge of our own README to the new viewer Signed-off-by: Diogo Teles Sant'Anna --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 534d468c396..f5e59c76d34 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # OpenSSF Scorecard -[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/ossf/scorecard/badge)](https://api.securityscorecards.dev/projects/github.com/ossf/scorecard) +[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/ossf/scorecard/badge)](https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard) [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/5621/badge)](https://bestpractices.coreinfrastructure.org/projects/5621) ![build](https://github.com/ossf/scorecard/workflows/build/badge.svg?branch=main) ![CodeQL](https://github.com/ossf/scorecard/workflows/CodeQL/badge.svg?branch=main)