diff --git a/.github/workflows/go-action.yml b/.github/workflows/go-dependency-submission.yml similarity index 66% rename from .github/workflows/go-action.yml rename to .github/workflows/go-dependency-submission.yml index f109c9f..90b7bef 100644 --- a/.github/workflows/go-action.yml +++ b/.github/workflows/go-dependency-submission.yml @@ -1,20 +1,26 @@ -name: Go Action detection of dependencies -on: +name: Go Dependency Submission +on push: branches: - main +# The API requires write permission on the repository to submit dependencies +permissions: + contents: write + jobs: go-action-detection: runs-on: ubuntu-latest steps: - name: 'Checkout Repository' uses: actions/checkout@v3 + - uses: actions/setup-go@v3 with: go-version: ">=1.18.0" + - name: Run snapshot action - uses: dsp-testing/go-snapshot-action@main + uses: actions/go-dependency-submission@main with: go-mod-path: go-example/go.mod go-build-target: go-example/cmd/octocat.go diff --git a/README.md b/README.md index 8f43ca2..e0ed4f6 100644 --- a/README.md +++ b/README.md @@ -10,19 +10,27 @@ on: push: branches: - main -# Envionment variables to configure Go and Go modules. Customize as necessary + +# The API requires write permission on the repository to submit dependencies +permissions: + contents: write + +# Environment variables to configure Go and Go modules. Customize as necessary env: GOPROXY: '' # A Go Proxy server to be used GOPRIVATE: '' # A list of modules are considered private and not requested from GOPROXY + jobs: go-action-detection: runs-on: ubuntu-latest steps: - name: 'Checkout Repository' uses: actions/checkout@v3 + - uses: actions/setup-go@v3 with: go-version: ">=1.18.0" + - name: Run snapshot action uses: actions/go-dependency-submission@main with: @@ -30,7 +38,7 @@ jobs: # build target go-mod-path: go-example/go.mod # - # Optinoal: Define the path of a build target (a file with a + # Optional: Define the path of a build target (a file with a # `main()` function) If not defined, this Action will collect all # dependencies used by all build targets for the module, which may # include Go dependencies used by tests and tooling.