|author||Zvonimir Pavlinovic <email@example.com>||Mon Aug 21 15:38:01 2023 -0700|
|committer||Zvonimir Pavlinovic <firstname.lastname@example.org>||Thu Aug 24 22:31:14 2023 +0000|
all: allow go.mod or go.work Go version to be used Fixes golang/go#61343 Change-Id: I844f3c83a4e8c6859e6e2527867533e363698b30 Reviewed-on: https://go-review.googlesource.com/c/govulncheck-action/+/521735 TryBot-Bypass: Zvonimir Pavlinovic <email@example.com> Reviewed-by: Ian Cottrell <firstname.lastname@example.org>
This repository holds the GitHub Action for govulncheck.
The govulncheck GitHub Action is currently experimental and is under active development.
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
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:
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.
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.
Unless otherwise noted, the Go source files are distributed under the BSD-style license found in the LICENSE file.