Skip to main content
Wir veröffentlichen regelmäßig Aktualisierungen unserer Dokumentation, und die Übersetzung dieser Seite ist möglicherweise noch nicht abgeschlossen. Aktuelle Informationen findest du in der englischsprachigen Dokumentation.
All products
REST-API
Die REST-API verfügt jetzt über eine Versionskontrolle. Weitere Informationen findest du unter Informationen zur API-Versionsverwaltung.

Abhängigkeitsübermittlung

Verwende die REST-API, um Abhängigkeiten zu übermitteln.

Informationen zu Abhängigkeitsübermittlungen

Hinweis: Die Möglichkeit zur Verwendung der REST-API für die Übermittlung von Abhängigkeiten befindet sich derzeit in der öffentlichen Betaversion und kann noch geändert werden.

Du kannst die REST-API verwenden, um Abhängigkeiten für ein Projekt zu übermitteln. Dadurch kannst du Abhängigkeiten wie die, die beim Kompilieren oder Erstellen von Software aufgelöst werden, zum Abhängigkeitsdiagrammfeature von GitHub hinzufügen und ein vollständigeres Bild aller Abhängigkeiten deines Projekts bieten.

Das Abhängigkeitsdiagramm zeigt alle Abhängigkeiten, die du mithilfe der API übermittelst, zusätzlich zu allen Abhängigkeiten, die von Manifest- oder Sperrdateien im Repository aus identifiziert werden (z. B. eine package-lock.json-Datei in einem JavaScript-Projekt). Weitere Informationen zur Anzeige des Abhängigkeitsdiagramms findest du unter Untersuchen der Abhängigkeiten eines Repositorys.

Übermittelte Abhängigkeiten erhalten Dependabot alerts und Dependabot security updates für alle bekannten Sicherheitsrisiken. Du empfängst Dependabot alerts nur für Abhängigkeiten, die von einem der unterstützten Ökosysteme von GitHub Advisory Database stammen. Übermittelte Abhängigkeiten werden nicht in Abhängigkeitsüberprüfungen oder den Abhängigkeitserkenntnissen deiner Organisation angezeigt.

Du kannst Abhängigkeiten in Form einer Momentaufnahme übermitteln. Eine Momentaufnahme ist eine Reihe von Abhängigkeiten, die einem Commit-SHA und anderen Metadaten zugeordnet sind, die den aktuellen Status deines Repositorys für einen Commit widerspiegeln. Du kannst dich entscheiden, vordefinierte Aktionen zu verwenden, oder eigene Aktionen zu erstellen, um jedes Mal, wenn dein Projekt erstellt wird, deine Abhängigkeiten im erforderlichen Format zu übermitteln. Weitere Informationen findest du unter Verwenden der Abhängigkeitsübermittlungs-API.

Du kannst mehrere Gruppen von Abhängigkeiten übermitteln, die in deinem Abhängigkeitsdiagramm enthalten sein sollen. Die REST-API verwendet die Eigenschaft job.correlator und die Kategorie detector.name der Momentaufnahme, um sicherzustellen, dass die neuesten Übermittlungen für jeden Workflow angezeigt werden. Die correlator-Eigenschaft selbst ist das primäre Feld, mit dem du unabhängige Übermittlungen auseinander hältst. Ein Beispiel correlator könnte eine einfache Kombination aus zwei Variablen sein, die in Aktionen verfügbar sind: <GITHUB_WORKFLOW> <GITHUB_JOB>.

Create a snapshot of dependencies for a repository

Funktioniert mit GitHub Apps

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.

Parameter für „Create a snapshot of dependencies for a repository“

Header
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
owner string Erforderlich

The account owner of the repository. The name is not case sensitive.

repo string Erforderlich

The name of the repository. The name is not case sensitive.

Textparameter
version integer Erforderlich

The version of the repository snapshot submission.

job object Erforderlich
id string Erforderlich

The external ID of the job.

correlator string Erforderlich

Correlator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of job.correlator and detector.name will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given "wave" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation.

html_url string

The url for the job.

sha string Erforderlich

The commit SHA associated with this dependency snapshot. Maximum length: 40 characters.

ref string Erforderlich

The repository branch that triggered this snapshot.

detector object Erforderlich

A description of the detector used.

name string Erforderlich

The name of the detector used.

version string Erforderlich

The version of the detector used.

url string Erforderlich

The url of the detector used.

metadata object

User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

manifests object

A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.

key object

A user-defined key to represent an item in manifests.

name string Erforderlich

The name of the manifest.

file object
source_location string

The path of the manifest file relative to the root of the Git repository.

metadata object

User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

resolved object

A collection of resolved package dependencies.

key object

A user-defined key to represent an item in resolved.

package_url string

Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.

metadata object

User-defined metadata to store domain-specific information limited to 8 keys with scalar values.

relationship string

A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.

Kann eine der Folgenden sein: direct, indirect

scope string

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

Kann eine der Folgenden sein: runtime, development

dependencies array of strings

Array of package-url (PURLs) of direct child dependencies.

scanned string Erforderlich

The time at which the snapshot was scanned.

HTTP-Antwortstatuscodes für „Create a snapshot of dependencies for a repository“

StatuscodeBESCHREIBUNG
201

Created

Codebeispiele für „Create a snapshot of dependencies for a repository“

post/repos/{owner}/{repo}/dependency-graph/snapshots
curl -L \ -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" }