You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api.md
+12-6Lines changed: 12 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,11 @@
2
2
title: Using the Dependency submission API
3
3
intro: 'You can use the Dependency submission API to submit dependencies for projects that resolve dependencies when the project is built or compiled.'
4
4
shortTitle: Dependency submission API
5
+
topics:
6
+
- API
7
+
- Dependency graph
8
+
- Dependencies
9
+
- REST
5
10
versions:
6
11
feature: dependency-submission-api
7
12
---
@@ -26,9 +31,9 @@ Actions that perform these steps for various ecosystems are available on {% data
26
31
27
32
Ecosystem | Action |
28
33
--- | --- |
29
-
TBD | TBD |
34
+
Go | [Go Dependency Submission](https://github.com/actions/go-dependency-submission)
30
35
31
-
For example, the following [Go Dependency Submission](https://github.com/dsp-testing/go-dependency-submission) workflow calculates the dependencies for a Go build-target (a Go file with a `main` function) and submits the list to the Dependency Submission API.
36
+
For example, the following [Go Dependency Submission](https://github.com/actions/go-dependency-submission) workflow calculates the dependencies for a Go build-target (a Go file with a `main` function) and submits the list to the Dependency Submission API.
32
37
33
38
```yaml
34
39
@@ -57,12 +62,13 @@ jobs:
57
62
# build target
58
63
go-mod-path: go-example/go.mod
59
64
#
60
-
# Define the repo path of a build target (a file with a
61
-
# `main()` function) If not defined, this Action will collect all
62
-
# dependencies used by all build targets for the module, which may
65
+
# Optional. Define the repo path of a build target,
66
+
# a file with a `main()` function.
67
+
# If undefined, this action will collect all dependencies
68
+
# used by all build targets for the module. This may
63
69
# include Go dependencies used by tests and tooling.
64
70
go-build-target: go-example/cmd/octocat.go
65
71
66
72
```
67
73
68
-
Alternatively, you can write your own action to perform these steps. {% data variables.product.product_name %} maintains the [Dependency Submission Toolkit](https://github.com/github/dependency-submission-toolkit), a TypeScript library to help you build your own GitHub Action for submitting dependencies to the Dependency Submission API. For more information about writing an action, see "[Creating actions](/actions/creating-actions)".
74
+
Alternatively, you can write your own action to perform these steps. {% data variables.product.product_name %} maintains the [Dependency Submission Toolkit](https://github.com/github/dependency-submission-toolkit), a TypeScript library to help you build your own GitHub Action for submitting dependencies to the Dependency submission API. For more information about writing an action, see "[Creating actions](/actions/creating-actions)".
The Dependency submission API lets you submit dependencies for a project to generate a dependency graph. This enables you to integrate dependencies that are resolved when software is compiled or built with {% data variables.product.prodname_dotcom %}'s dependency graph feature. For more information about viewing the dependency graph, see "[Exploring the dependencies of a repository](/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository#viewing-the-dependency-graph)." Submitted dependencies will receive {% data variables.product.prodname_dependabot_alerts %} and {% data variables.product.prodname_dependabot_security_updates %} for any known vulnerabilities.
2
2
3
-
Manifest or lock files in a repository that declare dependencies (for example, a `package-lock.json` file in a JavaScript project) will still be detected and parsed to populate the repository's dependency graph.
3
+
The dependency graph shows any dependencies you submit using the API in addition to any dependencies that are identified from manifest or lock files in the repository (for example, a `package-lock.json` file in a JavaScript project).
0 commit comments