Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы, возможно, еще выполняется. Актуальные сведения см. в документации на английском языке.
REST API теперь имеет версию. Дополнительные сведения см. в разделе Сведения об управлении версиями API.

Отправка зависимостей

Используйте REST API для отправки зависимостей.

Сведения об отправке зависимостей

Примечание: Возможность использования REST API для отправки зависимостей в настоящее время находится в общедоступной бета-версии и может быть изменена.

Для отправки зависимостей для проекта можно использовать REST API. Так вы сможете добавлять зависимости, например разрешаемые при компиляции или сборке программного обеспечения, в функцию графа зависимостей GitHub, чтобы создать более полную картину всех зависимостей проекта.

На графе зависимостей отображаются все зависимости, которые вы отправили через этот API, а также те, которые определены в файлах манифеста или блокировки, размещенных в репозитории (например, файл package-lock.json в проекте JavaScript). Дополнительные сведения о просмотре графа зависимостей см. в статье Изучение зависимостей репозитория.

Отправленные зависимости будут получать Dependabot alerts и Dependabot security updates по всем известным уязвимостям. Вы будете получать Dependabot alerts только для тех зависимостей, которые относятся к одной из поддерживаемых экосистем GitHub Advisory Database. Отправленные зависимости не будут отображаться при проверке зависимостей или в аналитических сведениях о зависимостях в вашей организации.

Зависимости можно отправлять в виде моментального снимка. Моментальный снимок — это набор зависимостей, связанных с SHA фиксации и другими метаданными, которые отражают текущее состояние репозитория для фиксации. Вы можете использовать готовые действия или создавать собственные действия для отправки зависимостей в требуемом формате при каждой сборке проекта. Дополнительные сведения см. в разделе Использование API отправки зависимостей.

Вы можете отправить несколько наборов зависимостей, которые будут включены в граф зависимостей. REST API использует job.correlator свойство и категорию detector.name моментального снимка для отображения последних отправок для каждого рабочего процесса. Само свойство correlator является основным полем, которое будет использоваться для различения независимых отправок. Например, в качестве correlator можно использовать простое сочетание двух переменных, доступных в выполнениях действий: <GITHUB_WORKFLOW> <GITHUB_JOB>.

Create a snapshot of dependencies for a repository

Работа с 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.

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

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

Параметры пути
Имя, Тип, Описание
ownerstringОбязательно

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

repostringОбязательно

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

Параметры запроса
Имя, Тип, Описание
versionintegerОбязательно

The version of the repository snapshot submission.

jobobjectОбязательно
Имя, Тип, Описание
idstringОбязательно

The external ID of the job.

correlatorstringОбязательно

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_urlstring

The url for the job.

shastringОбязательно

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

refstringОбязательно

The repository branch that triggered this snapshot.

detectorobjectОбязательно

A description of the detector used.

Имя, Тип, Описание
namestringОбязательно

The name of the detector used.

versionstringОбязательно

The version of the detector used.

urlstringОбязательно

The url of the detector used.

metadataobject

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

manifestsobject

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

Имя, Тип, Описание
keyobject

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

Имя, Тип, Описание
namestringОбязательно

The name of the manifest.

fileobject
Имя, Тип, Описание
source_locationstring

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

metadataobject

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

resolvedobject

A collection of resolved package dependencies.

Имя, Тип, Описание
keyobject

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

Имя, Тип, Описание
package_urlstring

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

metadataobject

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

relationshipstring

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

Может быть одним из: direct, indirect

scopestring

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.

Может быть одним из: runtime, development

dependenciesarray of strings

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

scannedstringОбязательно

The time at which the snapshot was scanned.

Коды состояния HTTP-ответа

Код состоянияОписание
201

Created

Примеры кода

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