Repository navigation
This release moves the action to Scorecard v5.7.0, built with Go 1.27.4. For changes to checks and results, and the security fixes in this Scorecard release, see the Scorecard v5.7.0 release notes.
Getting started
This is the first release with ready-to-use workflows in this repository. To add Scorecard to a repository, copy one
into .github/workflows/scorecard.yml:
examples/scorecard.ymlfor public repositories. It publishes results to the Scorecard API, which enables the badge and the REST API, and fails the step if the API rejects them.examples/scorecard-private.ymlfor private repositories. It doesn't publish.
Both pin every action to a full commit SHA, set cache-mode: none, and upload results even when an earlier step fails.
CI lints them with zizmor, actionlint and yamllint. If your linter reports cache-mode as unknown, see Workflow Linters.
Copy the examples from main, which pins this release. A tagged commit can't pin its own SHA, so the copies at the v2.6.0 tag still name v2.5.0.
To add the workflow to many repositories at once, the installer opens a pull request in each one.
See docs/installer.md.
What's Changed
- New
fail_on_publish_errorinput (defaultfalse): when set, the step fails if the Scorecard API rejects the results. Network errors and HTTP 408, 429 and 5xx stay warnings. New outputsresults_publishedandpublication_statusreport whether publishing worked, and the job summary says so. A rejected (4xx) publish is now sent once instead of three times, and the publish error and warning show as annotations. by @justaugustus in #1721 - Example workflows for public and private repositories in
examples/, with every action pinned to a full SHA. by @justaugustus in #1722 - The examples set
cache-mode: noneand upload results even when an earlier step fails. The README's new Workflow Linters section lists which linter versions recognizecache-mode. by @justaugustus in #1727 - The installer (
cmd/installer) adds the generated example workflow with the repository's default branch, and no longer needs a starter-workflows checkout. Usage is indocs/installer.md. by @justaugustus in #1728
Other
- Point getting started at the v2.6.0 example workflows by @justaugustus in #1750
- Lint the example workflows in CI by @justaugustus in #1724
- Move CI to golangci-lint v2 by @justaugustus in #1725
- Read
publish_resultsinto the options struct by @arpitjain099 in #1731 - Bump Scorecard to main ahead of v5.7.0 by @justaugustus in #1744
- Bump Scorecard to v5.7.0 by @justaugustus in #1746
Full Changelog: v2.5.0...v2.6.0