Diese Version von GitHub Enterprise Server wurde eingestellt am 2024-07-09. Es wird keine Patch-Freigabe vorgenommen, auch nicht für kritische Sicherheitsprobleme. Für bessere Leistung, verbesserte Sicherheit und neue Features aktualisiere auf die neueste Version von GitHub Enterprise Server. Wende dich an den GitHub Enterprise-Support, um Hilfe zum Upgrade zu erhalten.
REST-API-Endpunkte für die 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. Sie erhalten Dependabot alerts nur für Abhängigkeiten, die aus einem der unterstützten Ökosysteme für GitHub Advisory Database stammen. Weitere Informationen zu diesen Ökosystemen finden Sie unter „Informationen zu GitHub Advisory Database.“ Für transitive Abhängigkeiten, die über die Abhängigkeitsübermittlungs-API übermittelt werden, öffnet Dependabot automatisch Pull Requests, um die übergeordnete Abhängigkeit zu aktualisieren, wenn ein Update verfügbar ist.
Übermittelte Abhängigkeiten werden nicht in der Abhängigkeitsüberprüfung oder den Abhängigkeitserkenntnissen Ihrer 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
Create a new snapshot of a repository's dependencies.
The authenticated user must have access to the repository.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Parameter für „Create a snapshot of dependencies for a repository“
Name, type, BESCHREIBUNG |
---|
accept string Setting to |
Name, type, BESCHREIBUNG |
---|
owner string ErforderlichThe account owner of the repository. The name is not case sensitive. |
repo string ErforderlichThe name of the repository without the |
Name, type, BESCHREIBUNG | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
version integer ErforderlichThe version of the repository snapshot submission. | |||||||||||||||||||||
job object Erforderlich | |||||||||||||||||||||
Properties of |
Name, type, BESCHREIBUNG |
---|
id string ErforderlichThe external ID of the job. |
correlator string ErforderlichCorrelator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of |
html_url string The url for the job. |
sha
string ErforderlichThe commit SHA associated with this dependency snapshot. Maximum length: 40 characters.
ref
string ErforderlichThe repository branch that triggered this snapshot.
detector
object ErforderlichA description of the detector used.
Properties of detector
Name, type, BESCHREIBUNG |
---|
name string ErforderlichThe name of the detector used. |
version string ErforderlichThe version of the detector used. |
url string ErforderlichThe 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.
Properties of manifests
Name, type, BESCHREIBUNG | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
key object A user-defined key to represent an item in | ||||||||||||||||||
Properties of |
Name, type, BESCHREIBUNG | |||||||||
---|---|---|---|---|---|---|---|---|---|
name string ErforderlichThe name of the manifest. | |||||||||
file object | |||||||||
Properties of |
Name, type, BESCHREIBUNG |
---|
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.
Properties of resolved
Name, type, BESCHREIBUNG | ||||||
---|---|---|---|---|---|---|
key object A user-defined key to represent an item in | ||||||
Properties of |
Name, type, BESCHREIBUNG |
---|
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: |
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: |
dependencies array of strings Array of package-url (PURLs) of direct child dependencies. |
scanned
string ErforderlichThe time at which the snapshot was scanned.
HTTP-Antwortstatuscodes für „Create a snapshot of dependencies for a repository“
Statuscode | BESCHREIBUNG |
---|---|
201 | Created |
Codebeispiele für „Create a snapshot of dependencies for a repository“
Anforderungsbeispiel
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/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"
}