Soumission de dépendances
Utilisez l’API REST pour soumettre des dépendances.
À propos des soumissions de dépendances
Remarque : La possibilité d’utiliser l’API REST pour la soumission de dépendances est actuellement en version bêta publique et est susceptible d’être modifiée.
Vous pouvez utiliser l’API REST pour envoyer des dépendances pour un projet. Cela vous permet d’ajouter des dépendances, comme celles résolues quand le logiciel est compilé ou généré, au graphique de dépendance GitHub, pour une vue d’ensemble plus complète de l’ensemble des dépendances de votre projet.
Le graphique de dépendances affiche les dépendances que vous envoyez à l’aide de l’API, en plus des dépendances identifiées à partir de fichiers manifeste ou de verrouillage dans le référentiel (par exemple un fichier package-lock.json
dans un projet JavaScript). Pour plus d’informations sur l’affichage du graphique de dépendance, consultez « Exploration des dépendances d’un référentiel ».
Les dépendances envoyées reçoivent des Dependabot alerts et Dependabot security updates pour toutes les vulnérabilités connues. Vous recevez uniquement des Dependabot alerts pour les dépendances provenant de l’un des écosystèmes pris en charge par GitHub Advisory Database. Les dépendances envoyées ne sont pas exposées dans la révision des dépendances ou dans les insights de dépendance de votre organisation.
Vous pouvez soumettre des dépendances sous la forme d’un instantané. Une capture instantanée est un ensemble de dépendances associées à un SHA de commit et à d’autres métadonnées, qui reflète l’état actuel de votre dépôt pour un commit. Vous pouvez choisir d’utiliser des actions prédéfinies ou de créer vos propres actions pour soumettre vos dépendances au format requis chaque fois que votre projet est généré. Pour plus d'informations, voir « Utilisation de l’API de soumission de dépendances ».
Vous pouvez soumettre plusieurs ensembles de dépendances afin de les inclure dans votre graphe des dépendances. L’API REST utilise la propriété job.correlator
et la catégorie detector.name
de l’instantané pour garantir l’affichage des dernières soumissions pour chaque workflow. La propriété correlator
elle-même est le champ principal que vous utiliserez pour veiller à ce que les soumissions indépendantes soient distinctes. Un exemple de correlator
pourrait être une combinaison simple de deux variables disponibles dans des exécutions d’actions : <GITHUB_WORKFLOW> <GITHUB_JOB>
.
Create a snapshot of dependencies for a repository
Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the repo
scope to use this endpoint for a repository that the requesting user has access to.
Parameters
Headers | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Nom, Type, Description | ||||||||||||||||||||||||||||||||||||
accept stringSetting to | ||||||||||||||||||||||||||||||||||||
Path parameters | ||||||||||||||||||||||||||||||||||||
Nom, Type, Description | ||||||||||||||||||||||||||||||||||||
owner stringRequiredThe account owner of the repository. The name is not case sensitive. | ||||||||||||||||||||||||||||||||||||
repo stringRequiredThe name of the repository. The name is not case sensitive. | ||||||||||||||||||||||||||||||||||||
Body parameters | ||||||||||||||||||||||||||||||||||||
Nom, Type, Description | ||||||||||||||||||||||||||||||||||||
version integerRequiredThe version of the repository snapshot submission. | ||||||||||||||||||||||||||||||||||||
job objectRequired | ||||||||||||||||||||||||||||||||||||
Properties of |
Nom, Type, Description |
---|
id stringRequiredThe external ID of the job. |
correlator stringRequiredCorrelator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of |
html_url stringThe url for the job. |
sha
stringRequiredThe commit SHA associated with this dependency snapshot. Maximum length: 40 characters.
ref
stringRequiredThe repository branch that triggered this snapshot.
detector
objectRequiredA description of the detector used.
Properties of detector
Nom, Type, Description |
---|
name stringRequiredThe name of the detector used. |
version stringRequiredThe version of the detector used. |
url stringRequiredThe url of the detector used. |
metadata
objectUser-defined metadata to store domain-specific information limited to 8 keys with scalar values.
manifests
objectA collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.
Properties of manifests
Nom, Type, Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
key objectA user-defined key to represent an item in | ||||||||||||||||||||||||||||||
Properties of |
Nom, Type, Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name stringRequiredThe name of the manifest. | |||||||||||||||
file object | |||||||||||||||
Properties of |
Nom, Type, Description |
---|
source_location stringThe path of the manifest file relative to the root of the Git repository. |
metadata
objectUser-defined metadata to store domain-specific information limited to 8 keys with scalar values.
resolved
objectA collection of resolved package dependencies.
Properties of resolved
Nom, Type, Description | |||||||||
---|---|---|---|---|---|---|---|---|---|
key objectA user-defined key to represent an item in | |||||||||
Properties of |
Nom, Type, Description |
---|
package_url stringPackage-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. |
metadata objectUser-defined metadata to store domain-specific information limited to 8 keys with scalar values. |
relationship stringA notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency. Can be one of: |
scope stringA notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes. Can be one of: |
dependencies array of stringsArray of package-url (PURLs) of direct child dependencies. |
scanned
stringRequiredThe time at which the snapshot was scanned.
HTTP response status codes
Status code | Description |
---|---|
201 | Created |
Code samples
curl \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>"\
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/repos/OWNER/REPO/dependency-graph/snapshots \
-d '{"version":0,"sha":"ce587453ced02b1526dfb4cb910479d431683101","ref":"refs/heads/main","job":{"correlator":"yourworkflowname_youractionname","id":"yourrunid"},"detector":{"name":"octo-detector","version":"0.0.1","url":"https://github.com/octo-org/octo-repo"},"scanned":"2022-06-14T20:25:00Z","manifests":{"package-lock.json":{"name":"package-lock.json","file":{"source_location":"src/package-lock.json"},"resolved":{"@actions/core":{"package_url":"pkg:/npm/%40actions/core@1.1.9","dependencies":["@actions/http-client"]},"@actions/http-client":{"package_url":"pkg:/npm/%40actions/http-client@1.0.7","dependencies":["tunnel"]},"tunnel":{"package_url":"pkg:/npm/tunnel@0.0.6"}}}}}'
Response
Status: 201
{
"id": 12345,
"created_at": "2018-05-04T01:14:52Z",
"message": "Dependency results for the repo have been successfully updated.",
"result": "SUCCESS"
}