Scorecard supply-chain security workflow (google/closure-compiler)
The Scorecard supply-chain security workflow from google/closure-compiler, explained and optimized by Latchkey.
CI health: C - fair
Point runs-on at Latchkey and get run de-duplication, job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.
What it does
This is the Scorecard supply-chain security workflow from the google/closure-compiler repository, a real project running GitHub Actions. It is shown here with attribution under its Apache-2.0 license.
Below, Latchkey shows a faster, safer version produced by its optimization engine.
The workflow
# This workflow uses actions that are not certified by GitHub. They are provided
# by a third-party and are governed by separate terms of service, privacy
# policy, and support documentation.
name: Scorecard supply-chain security
on:
# For Branch-Protection check. Only the default branch is supported. See
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
branch_protection_rule:
# To guarantee Maintained check is occasionally updated. See
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
schedule:
- cron: '43 23 * * 6'
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
# Declare default permissions as read only.
permissions: read-all
jobs:
analysis:
name: Scorecard analysis
runs-on: ubuntu-latest
permissions:
# Needed to upload the results to code-scanning dashboard.
security-events: write
# Needed to publish results and get a badge (see publish_results below).
id-token: write
# Uncomment the permissions below if installing in a private repository.
# contents: read
# actions: read
steps:
- name: "Checkout code"
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
with:
persist-credentials: false
# - name: "Run analysis"
# uses: ossf/scorecard-action@v2
# with:
# results_file: results.sarif
# results_format: sarif
# # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
# # - you want to enable the Branch-Protection check on a *public* repository, or
# # - you are installing Scorecard on a *private* repository
# # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
# # repo_token: ${{ secrets.SCORECARD_TOKEN }}
#
# # Public repositories:
# # - Publish results to OpenSSF REST API for easy access by consumers
# # - Allows the repository to include the Scorecard badge.
# # - See https://github.com/ossf/scorecard-action#publishing-results.
# # For private repositories:
# # - `publish_results` will always be set to `false`, regardless
# # of the value entered here.
# publish_results: true
# Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
# format to the repository Actions tab.
- name: "Upload artifact"
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: SARIF file
path: results.sarif
retention-days: 5
# # Upload the results to GitHub's code scanning dashboard.
# - name: "Upload to code-scanning"
# uses: github/codeql-action/upload-sarif@v3
# with:
# sarif_file: results.sarif
The same workflow, on Latchkey
Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.
# This workflow uses actions that are not certified by GitHub. They are provided # by a third-party and are governed by separate terms of service, privacy # policy, and support documentation. name: Scorecard supply-chain security on: # For Branch-Protection check. Only the default branch is supported. See # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection branch_protection_rule: # To guarantee Maintained check is occasionally updated. See # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained schedule: - cron: '43 23 * * 6' push: branches: [ "master" ] pull_request: branches: [ "master" ] # Declare default permissions as read only. permissions: read-all concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: analysis: timeout-minutes: 30 name: Scorecard analysis runs-on: latchkey-small permissions: # Needed to upload the results to code-scanning dashboard. security-events: write # Needed to publish results and get a badge (see publish_results below). id-token: write # Uncomment the permissions below if installing in a private repository. # contents: read # actions: read steps: - name: "Checkout code" uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: persist-credentials: false # - name: "Run analysis" # uses: ossf/scorecard-action@v2 # with: # results_file: results.sarif # results_format: sarif # # (Optional) "write" PAT token. Uncomment the `repo_token` line below if: # # - you want to enable the Branch-Protection check on a *public* repository, or # # - you are installing Scorecard on a *private* repository # # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat. # # repo_token: ${{ secrets.SCORECARD_TOKEN }} # # # Public repositories: # # - Publish results to OpenSSF REST API for easy access by consumers # # - Allows the repository to include the Scorecard badge. # # - See https://github.com/ossf/scorecard-action#publishing-results. # # For private repositories: # # - `publish_results` will always be set to `false`, regardless # # of the value entered here. # publish_results: true # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF # format to the repository Actions tab. - name: "Upload artifact" uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: SARIF file path: results.sarif retention-days: 5 # # Upload the results to GitHub's code scanning dashboard. # - name: "Upload to code-scanning" # uses: github/codeql-action/upload-sarif@v3 # with: # sarif_file: results.sarif
What changed
- Run on Latchkey managed runners with one line (
runs-on), which apply the fixes below automatically and self-heal transient failures. This example useslatchkey-small; pick the runner size that fits the job. - Cancel superseded runs when a branch or PR gets a newer push.
- Add a job timeout so a hung step cannot burn hours of runner time.
1 third-party action is referenced by a movable tag. Pin it to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.
This workflow runs 1 job per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.