GitHub action for govulncheck

Clone this repo:
  1. 3a32958 action.yml: update actions to latest versions by Tobias Klauser · 8 weeks ago master v1 v1.0.2
  2. 7da72f7 all: allow go.mod or go.work Go version to be used by Zvonimir Pavlinovic · 7 months ago v1.0.1
  3. b56219a action.yml: provide option to checkout repository by Zvonimir Pavlinovic · 7 months ago
  4. 5f206a9 actions.yml: add working directory input by Zvonimir Pavlinovic · 7 months ago
  5. dd3ead0 README.md: update version to v1 by Julie Qiu · 8 months ago v1.0.0

GitHub Action for govulncheck

This repository holds the GitHub Action for govulncheck.

Govulncheck provides a low-noise, reliable way for Go users to learn about known vulnerabilities that may affect their dependencies. See details on Go's support for vulnerability management.

The govulncheck GitHub Action is currently experimental and is under active development.

Using the govulncheck GitHub Action

To use the govulncheck GitHub Action add the following step to your workflow:

- id: govulncheck
  uses: golang/govulncheck-action@v1

By default the govulncheck Github Action will run with the latest version of Go and analyze all packages in the provided Go module. Assuming you have the latest Go version installed locally, this is equivalent to running the following on your command line:

$ govulncheck ./...

To specify a specific Go version, directory in which to run govulncheck, or package pattern, use the following syntax:

- id: govulncheck
  uses: golang/govulncheck-action@v1
  with:
     go-version-input: <your-Go-version>
     go-package: <your-package-pattern>

For example, the code snippet below can be used to run govulncheck against a repository on every push:

on: [push]

jobs:
  govulncheck_job:
    runs-on: ubuntu-latest
    name: Run govulncheck
    steps:
      - id: govulncheck
        uses: golang/govulncheck-action@v1
        with:
           go-version-input: 1.20.6
           go-package: ./...

govulncheck Github Action accepts several other optional inputs:

work-dir: directory in which to run govulncheck, default '.'
repo-checkout: checkout the repository, default true
check-latest: check for the latest Go version, default false
go-version-file: go.mod or go.work file specifying Go version, default ''

The precedence for inputs go-version-input, go-version-file, and check-latest specifying Go version is inherited from actions/setup-go.

When a vulnerability is found, an error will be displayed for that GitHub job with information about the vulnerability and how to fix it. For example:

image

Contributing

Our canonical Git repository is located at https://go.googlesource.com/govulncheck-action. There is a mirror of the repository at https://github.com/golang/govulncheck-action. See https://go.dev/doc/contribute.html for details on how to contribute.

Feedback

The main issue tracker for the time repository is located at

If you want to report a bug or have a feature suggestion, please file an issue at https://github.com/golang/go/issues, prefixed with govulncheck-action: in the title.

License

Unless otherwise noted, the Go source files are distributed under the BSD-style license found in the LICENSE file.