Merge pull request #5 from dsp-testing/lsep/go-list-impl

Go list implementation for detecting dependencies

Author: lseppala

.github/workflows/go-action.yml

@@ -0,0 +1,19 @@
+name: Go Action detection of dependencies
+on:
+  push:
+    branches:
+      - main
+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@lsep/go-list-impl
+        with:
+          go-mod-path: go-example/go.mod
+          go-build-target: go-example/cmd/octocat.go

README.md

@@ -5,7 +5,7 @@ An Action that creates a dependency submission using `go mod graph`.
 Optional inputs for the Action include: `detector-name`, `detector-url`, `detector-version`, and `metadata` - a JSON of max eight keys to provide with the snapshot.
 
 ### Example
-```
+```yaml
 name: Go Action detection of dependencies
 on:
   push:
@@ -27,6 +27,16 @@ jobs:
       - name: Run snapshot action
         uses: @dsp-testing/go-snapshot-action
         with:
+            # Required: Define the repo path to the go.mod file used by the
+            # build target
+            go-mod-path: go-example/go.mod
+            #
+            # Define the repo path of a build target (a file with a
+            # `main()` function) If not defined, this Aciton will collect all
+            # dependencies used by all build targets for the module, which may
+            # include Go dependencies used by tests and tooling.
+            go-build-target: go-example/cmd/octocat.go
+            #
             # All of the below have defaults, but can be overriden manually
             detector-name: go snapshot action
             detector-url: ${{ github.server_url }}/${{ github.repository }}

action.yml

@@ -21,6 +21,13 @@ inputs:
   metadata:
     required: false
     description: 'User provided map of max key/value pairs of metadata to include with the snapshot e.g. {"lastModified": "12-31-2022"}'
+  go-mod-path:
+    required: true
+    description: 'Repo path to the go.mod file used to detect dependencies for the Go build target'
+  go-build-target:
+    required: true
+    description: 'Build target to detect build dependencies. If unspecified, will use "all", with will detect all dependencies used in all build targets (including tests and tools).'
+    default: 'all'
 runs:
   using: 'node16'
   main: 'dist/index.js'