Skip to content
This repository was archived by the owner on Jun 16, 2022. It is now read-only.

Commit c209c60

Browse files
authored
Update README.md
1 parent 04e7901 commit c209c60

File tree

1 file changed

+1
-38
lines changed

1 file changed

+1
-38
lines changed

README.md

Lines changed: 1 addition & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1 @@
1-
# Go Dependency Submission
2-
3-
This GitHub Action calculates dependencies for a Go build-target (a Go file with a
4-
`main` function) and submits the list to the [Dependency submission API](https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api). Dependencies then appear in your repository's dependency graph, and you'll receive Dependabot alerts and updates for vulnerable or out-of-date dependencies.
5-
6-
### Example
7-
```yaml
8-
name: Go Dependency Submission
9-
on:
10-
push:
11-
branches:
12-
- main
13-
# Envionment variables to configure Go and Go modules. Customize as necessary
14-
env:
15-
GOPROXY: '' # A Go Proxy server to be used
16-
GOPRIVATE: '' # A list of modules are considered private and not requested from GOPROXY
17-
jobs:
18-
go-action-detection:
19-
runs-on: ubuntu-latest
20-
steps:
21-
- name: 'Checkout Repository'
22-
uses: actions/checkout@v3
23-
- uses: actions/setup-go@v3
24-
with:
25-
go-version: ">=1.18.0"
26-
- name: Run snapshot action
27-
uses: @dsp-testing/go-snapshot-action
28-
with:
29-
# Required: Define the repo path to the go.mod file used by the
30-
# build target
31-
go-mod-path: go-example/go.mod
32-
#
33-
# Define the repo path of a build target (a file with a
34-
# `main()` function) If not defined, this Action will collect all
35-
# dependencies used by all build targets for the module, which may
36-
# include Go dependencies used by tests and tooling.
37-
go-build-target: go-example/cmd/octocat.go
38-
```
1+
# This repo has been archived. It now lives at [actions/go-dependency-submission](https://github.com/actions/go-dependency-submission)

0 commit comments

Comments
 (0)