OpenFermion/.github/workflows/osv-scanner.yaml at 8acd3111f41c1418ebddf4effd98d253df47e487 · quantumlib/OpenFermion · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# Zero-config modular workflow to run Open Source Vulnerabilities code scans.
#
# The OSV scanner is a dependency vulnerability scanner that identifies known
# vulnerabilities in a project's dependencies. It supports C/C++, Python, Java,
# JavaScript, and others. The findings are reported in the repo's code-scanning
# results page, https://github.com/quantumlib/REPO/security/code-scanning/.
#
# The OSV project provides a GA workflow that you can reference as a step with
# uses: google/osv-scanner-action/.github/workflows/osv-scanner-reusable-pr.yml.
# Unfortunately, that workflow hardcodes some behaviors (such as uploading the
# SARIF file to the workflow Actions tab, which we rarely need). The workflow
# below is basically a heavily modified version of theirs.
#
# For more OSV scanner examples and options, including how to ignore specific
# vulnerabilities, see https://google.github.io/osv-scanner/github-action/.
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

name: OSV code scan
run-name: Run OSV vulnerability scanner ${{inputs.reason}}

on:
  pull_request:
    types: [opened, synchronize]
    branches:
      - main
      - master

  # Support merge queues.
  merge_group:
    types:
      - checks_requested

  # Allow manual invocation.
  workflow_dispatch:

  # Allow calling from nightly.yaml.
  workflow_call:
    inputs:
      reason:
        type: string

# Declare default permissions as read only.
permissions: read-all

jobs:
  osv-scan:
    name: Run OSV scanner
    runs-on: ubuntu-24.04
    timeout-minutes: 15
    permissions:
      # Needed to read commit contents:
      actions: read
      # Needed to upload the results to code-scanning dashboard:
      security-events: write
      # Needed to upload SARIF file to CodeQL.
      contents: read
    steps:
      - name: Check out a copy of the git repository
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          fetch-depth: 0

      - name: Check out the target branch
        run: |
          git checkout ${{github.base_ref || github.ref_name}}
          git submodule update --recursive

      - name: Run OSV scanner on existing code
        # yamllint disable rule:line-length
        uses: google/osv-scanner-action/osv-scanner-action@6fc714450122bda9d00e4ad5d639ad6a39eedb1f # v2.0.1
        continue-on-error: true
        with:
          scan-args: |-
            --format=json
            --output=old-results.json
            --recursive
            ./

      - name: Check out current branch
        # Use -f in case any changes were made by osv-scanner.
        run: |
          git checkout -f "$GITHUB_SHA"
          git submodule update --recursive

      - name: Run OSV scanner on new code
        # yamllint disable rule:line-length
        uses: google/osv-scanner-action/osv-scanner-action@6fc714450122bda9d00e4ad5d639ad6a39eedb1f # v2.0.1
        continue-on-error: true
        with:
          scan-args: |-
            --format=json
            --output=new-results.json
            --recursive
            ./

      - name: Run the OSV scanner reporter
        # yamllint disable rule:line-length
        uses: google/osv-scanner-action/osv-reporter-action@6fc714450122bda9d00e4ad5d639ad6a39eedb1f # v2.0.1
        with:
          scan-args: |-
            --output=osv-results.sarif
            --old=old-results.json
            --new=new-results.json
            --gh-annotations=true
            --fail-on-vuln=true

      - name: Upload results to the repository's code-scanning results dashboard
        id: upload_artifact
        # yamllint disable rule:line-length
        uses: github/codeql-action/upload-sarif@1b549b9259bda1cb5ddde3b41741a82a2d15a841 # v3.28.13
        with:
          sarif_file: osv-results.sarif

      - name: Error troubleshooter
        if: ${{always() && steps.upload_artifact.outcome == 'failure'}}
        run: echo '::error::Artifact upload failed. Check the workflow logs.'