The REST API is now versioned. For more information, see "About API versioning."

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

API отправки зависимостей можно использовать для отправки зависимостей для проектов, например зависимостей, разрешенных при сборке или компиляции проекта.

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

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

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

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

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

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

Вы можете отправить в API отправки зависимостей несколько наборов зависимостей, которые нужно включить в граф зависимостей. Этот 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.

Параметры

Headers

Name, Type, Description

acceptstring

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

Path parameters

Name, Type, Description

ownerstringRequired

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

repostringRequired

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

Body parameters

Name, Type, Description

versionintegerRequired

The version of the repository snapshot submission.

jobobjectRequired

Properties of job

Name, Type, Description
`id`stringRequired The external ID of the job.
`correlator`stringRequired 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.

shastringRequired

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

refstringRequired

The repository branch that triggered this snapshot.

detectorobjectRequired

A description of the detector used.

Properties of detector

Name, Type, Description
`name`stringRequired The name of the detector used.
`version`stringRequired The version of the detector used.
`url`stringRequired 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.

Properties of manifests

Name, Type, Description

keyobject

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

Properties of key

Name, Type, Description

namestringRequired

The name of the manifest.

fileobject

Properties of file

Name, Type, Description
`source_location`string 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.

Properties of resolved

Name, Type, Description

keyobject

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

Properties of key

Name, Type, Description
`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. Can be one of: `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. Can be one of: `runtime`, `development`
`dependencies`array of strings Array of package-url (PURLs) of direct child dependencies.

scannedstringRequired

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"
}

Dec	JAN	Feb
	05
2022	2023	2024