v2.5.0

What's Changed

This release moves the action to Scorecard v5.6.0, the first Scorecard release since its hosted
services moved to new infrastructure.

For changes to checks and results, and what the infrastructure move means for you, see the
Scorecard v5.6.0 release notes.

• The action's container image is built with Go 1.27.2 on a refreshed distroless base. by
  @justaugustus in #1716
• The installer (cmd/installer) now creates .github/workflows/scorecard.yml, and still
  recognizes existing scorecards.yml and scorecards-analysis.yml workflows. by @justaugustus in #1716
• The Scorecard version in results now always matches the Scorecard release the action is built
  with. by @justaugustus in #1718
• The action no longer prints the GitHub token variable while validating its options. by
  @arpitjain099 in #1709
• results_format accepts intoto, which wraps the JSON results in an in-toto attestation
  statement. by @puerco in #1702

Other

• Add a daily canary against Scorecard main by @justaugustus in #1711
• Bump Scorecard to the v5.6.0 candidate and fix the canary toolchain by @justaugustus in #1714
• Run Scorecard on every merge, add a zizmor presubmit, analyze workflows with CodeQL, and update
  RELEASE.md by @justaugustus in #1716
• Bump Scorecard to v5.6.0 by @justaugustus in #1719

New Contributors

• @arpitjain099 made their first contribution in #1709
• @puerco made their first contribution in #1702

Full Changelog: v2.4.4...v2.5.0

v2.4.4

What's Changed

This update bumps the Scorecard version to the v5.5.0 release. For a complete list of changes, please refer to the Scorecard v5.4.0 release notes and the Scorecard v5.5.0 release notes.

• log POST failures instead of failing entire action by @spencerschrock in #1625

Full Changelog: v2.4.3...v2.4.4

v2.4.3

What's Changed

This update bumps the Scorecard version to the v5.3.0 release. For a complete list of changes, please refer to the Scorecard v5.3.0 release notes.

Documentation

• docs: clarify GITHUB_TOKEN permissions needed for private repos by @pankajtaneja5 in #1574
• 📖 Fix recommended command to test the image in development by @deivid-rodriguez in #1583

Other

• add missing top-level token permissions to workflows by @timothyklee in #1566
• setup codeowners for requesting reviews by @spencerschrock in #1576
• 🌱 Improve printing options by @deivid-rodriguez in #1584

New Contributors

• @timothyklee made their first contribution in #1566
• @pankajtaneja5 made their first contribution in #1574
• @deivid-rodriguez made their first contribution in #1584

Full Changelog: v2.4.2...v2.4.3

v2.4.2

What's Changed

This update bumps the Scorecard version to the v5.2.1 release. For a complete list of changes, please refer to the Scorecard v5.2.0 and v5.2.1 release notes.

Full Changelog: v2.4.1...v2.4.2

v2.4.1

What's Changed

• This update bumps the Scorecard version to the v5.1.1 release. For a complete list of changes, please refer to the v5.1.0 and v5.1.1 release notes.
• Publishing results now uses half the API quota as before. The exact savings depends on the repository in question.
  • use Scorecard library entrypoint instead of Cobra hooking by @spencerschrock in #1423
• Some errors were made into annotations to make them more visible
  • Make default branch error more prominent by @jsoref in #1459
• There is now an optional file_mode input which controls how repository files are fetched from GitHub. The default is archive, but git produces the most accurate results for repositories with .gitattributes files at the cost of analysis speed.
  • add input for specifying --file-mode by @spencerschrock in #1509
• The underlying container for the action is now hosted on GitHub Container Registry. There should be no functional changes.
  • 🌱 publish docker images to GitHub Container Registry by @spencerschrock in #1453

Docs

• Installation docs update by @JeremiahAHoward in #1416

New Contributors

• @JeremiahAHoward made their first contribution in #1416
• @jsoref made their first contribution in #1459
  Full Changelog: v2.4.0...v2.4.1

v2.4.0

What's Changed

This update bumps the Scorecard version to the v5 release. For a complete list of changes, please refer to the v5.0.0 release notes. Of special note to Scorecard Action is the Maintainer Annotation feature, which can be used to suppress some Code Scanning false positives. Alerts will not be generated for any Scorecard Check with an annotation.

• 🌱 Bump github.com/ossf/scorecard/v5 from v5.0.0-rc2 to v5.0.0 by @spencerschrock in #1410
• 🐛 lower license sarif alert threshold to 9 by @spencerschrock in #1411

Documentation

• docs: dogfooding badge by @jkowalleck in #1399

New Contributors

• @jkowalleck made their first contribution in #1399

Full Changelog: v2.3.3...v2.4.0

v2.3.3

Note

There is no v2.3.2 release as a step was skipped in the release process. This was fixed and re-released under the v2.3.3 tag

What's Changed

• 🌱 Bump github.com/ossf/scorecard/v4 (v4.13.1) to github.com/ossf/scorecard/v5 (v5.0.0-rc1) by @spencerschrock in #1366
• 🌱 Bump github.com/ossf/scorecard/v5 from v5.0.0-rc1 to v5.0.0-rc2 by @spencerschrock in #1374
• 🌱 Bump github.com/ossf/scorecard/v5 from v5.0.0-rc2 to v5.0.0-rc2.0.20240509182734-7ce860946928 by @spencerschrock in #1377

For a full changelist of what these include, see the v5.0.0-rc1 and v5.0.0-rc2 release notes.

Documentation

• 📖 Move token discussion out of main README. by @spencerschrock in #1279
• 📖 link to ossf/scorecard workflow instead of maintaining an example by @spencerschrock in #1352
• 📖 update api links to new scorecard.dev site by @spencerschrock in #1376

Full Changelog: v2.3.1...v2.3.3

v2.3.1

What's Changed

• 🌱 Bump github.com/ossf/scorecard/v4 from v4.13.0 to v4.13.1 by @spencerschrock in #1282
  • Adds additional Fuzzing detection and fixes a SAST bug related to detecting CodeQL. For a full changelist of what this includes, see the v4.13.1 release notes

Full Changelog: v2.3.0...v2.3.1

v2.3.0

What's Changed

• 🌱 Bump github.com/ossf/scorecard/v4 from v4.11.0 to v4.13.0 by @spencerschrock in #1270
  • For a full changelist of what this includes, see the v4.12.0 and v4.13.0 release notes
• ✨ Send rekor tlog index to webapp when publishing results by @spencerschrock in #1169
• 🐛 Prevent url clipping for GHES instances by @rajbos in #1225

Documentation

• 📖 Update access rights needed to see the results in code scanning by @rajbos in #1229
• 📖 Add package comments. by @spencerschrock in #1221
• 📖 Add SECURITY.md file by @david-a-wheeler in #1250
• 📖 Fix typo in token input docs by @aabouzaid in #1258

New Contributors

• @david-a-wheeler made their first contribution in #1250
• @aabouzaid made their first contribution in #1258

Full Changelog: v2.2.0...v2.3.0

v2.2.0

What's Changed

• 🌱 Bump github.com/ossf/scorecard/v4 from v4.10.5 to v4.11.0 by @spencerschrock in #1192

Scorecard Result Viewer

Thanks to contributions from @cynthia-sg and @tegioz at CLOMonitor, there is a new Scorecard Result visualization page at https://securityscorecards.dev/viewer/?uri=<project-url>.

• ossf/scorecard-webapp#406
• ossf/scorecard-webapp#422

As an example, you can see our own score visualized here
Checkout our README to learn how to link your README badge to the new visualization page.

Publishing Results

This release contains two fixes which will improve the user experience when publish_results is true

• Runs that fail our workflow restrictions will fail with a 400 response indicating the problem, instead of a vague 500 status. (#1156, resolved #1150)
• Scorecard action will retry when signing results and submitting them to our web API. This should help with flakiness from connection failures. (#1191)

Docs

• 📖 Update README to accept fine-grained tokens by @pnacht in #1175
• 📖 Update installation instructions to match current GitHub UI by @joycebrum in #1153
• 📖 Document the GitHub action workflow restrictions when publishing results. by @spencerschrock in

New Contributors

• @bobcallaway made their first contribution in #1140
• @pnacht made their first contribution in #1175

Full Changelog: v2.1.3...v2.2.0