Skip to content

Commit 723444d

Browse files
saritaifelicitymaycourtneycl
authored
Apply suggestions from code review
Co-authored-by: Felicity Chapman <[email protected]> Co-authored-by: Courtney Claessens <[email protected]>
1 parent 872bd3c commit 723444d

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

content/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
title: Using the Dependency submission API
33
intro: 'You can use the Dependency submission API to submit dependencies for projects that resolve dependencies when the project is built or compiled.'
44
shortTitle: Dependency submission API
5+
topics:
6+
- API
7+
- Dependency graph
8+
- Dependencies
9+
- REST
510
versions:
611
feature: dependency-submission-api
712
---
@@ -26,9 +31,9 @@ Actions that perform these steps for various ecosystems are available on {% data
2631

2732
Ecosystem | Action |
2833
--- | --- |
29-
TBD | TBD |
34+
Go | [Go Dependency Submission](https://github.com/actions/go-dependency-submission)
3035

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.
3237

3338
```yaml
3439

@@ -57,12 +62,13 @@ jobs:
5762
# build target
5863
go-mod-path: go-example/go.mod
5964
#
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
6369
# include Go dependencies used by tests and tooling.
6470
go-build-target: go-example/cmd/octocat.go
6571

6672
```
6773

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)".
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
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.
22

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

Comments
 (0)