Skip to main content

Envio de dependência

A API de envio de dependências permite que você envie dependências para projetos, como as dependências resolvidas quando um projeto é construído ou compilado.

Sobre a API de envio de dependência

Note: The Dependency submission API is currently in public beta and subject to change.

The Dependency submission API lets you submit dependencies for a project. This enables you to add dependencies, such as those resolved when software is compiled or built, to GitHub's dependency graph feature, providing a more complete picture of all of your project's dependencies.

The dependency graph shows any dependencies you submit using the API in addition to any dependencies that are identified from manifest or lock files in the repository (for example, a package-lock.json file in a JavaScript project). For more information about viewing the dependency graph, see "Exploring the dependencies of a repository."

Submitted dependencies will receive Alertas do Dependabot and Atualizações de segurança do Dependabot for any known vulnerabilities. Você só obterá Alertas do Dependabot para dependências que são de um dos ecossistemas compatíveis do Banco de Dados Consultivo GitHub. Submitted dependencies will not be surfaced in dependency review or your organization's dependency insights.

As dependências são enviadas para a API de envio de dependência na forma de um instantâneo. Um instantâneo é um conjunto de dependências associadas a um commit SHA e outros metadados, que reflete o estado atual do seu repositório para um commit. Você pode optar por usar ações pré-criadas ou criar suas próprias ações para enviar suas dependências para a API de envio de dependências no formato exigido cada vez que o seu projeto for criado. Para obter mais informações sobre o uso da API de envio de dependências, consulte "Usando a API de envio de dependência".

Você pode enviar vários conjuntos de dependências para a API de submissão de dependências a ser incluídos no seu gráfico de dependências. A API usa a propriedade job.correlator e a categoria detector.name do instantâneo para garantir que as submissões mais recentes para cada fluxo de trabalho sejam exibidas. A propriedade correlator é o campo primário que você usará para manter os envios independentes distintos. Um exemplo de correlator pode ser uma combinação simples de duas variáveis disponíveis em ações executadas: <GITHUB_WORKFLOW> <GITHUB_JOB>.

Create a snapshot of dependencies for a repository

Works with 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.

Parâmetros

Headers
Nome, Tipo, Descrição
acceptstring

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

Path parameters
Nome, Tipo, Descrição
ownerstringObrigatório

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

repostringObrigatório

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

Body parameters
Nome, Tipo, Descrição
versionintegerObrigatório

The version of the repository snapshot submission.

jobobjectObrigatório
Nome, Tipo, Descrição
idstringObrigatório

The external ID of the job.

correlatorstringObrigatório

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.

shastringObrigatório

The commit SHA associated with this dependency snapshot.

refstringObrigatório

The repository branch that triggered this snapshot.

detectorobjectObrigatório

A description of the detector used.

Nome, Tipo, Descrição
namestringObrigatório

The name of the detector used.

versionstringObrigatório

The version of the detector used.

urlstringObrigatório

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

Nome, Tipo, Descrição
keystring

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

Nome, Tipo, Descrição
namestringObrigatório

The name of the manifest.

fileobject
metadataobject

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

resolved
Nome, Tipo, Descrição
source_locationstring

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

Nome, Tipo, Descrição
keystring

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

Nome, Tipo, Descrição
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.

Pode ser uma das ações a seguir: 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.

Pode ser uma das ações a seguir: runtime, development

dependenciesarray of strings

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

scannedstringObrigatório

The time at which the snapshot was scanned.

HTTP response status codes

Status codeDescrição
201

Created

Amostras de código

post/repos/{owner}/{repo}/dependency-graph/snapshots
curl \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ 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" }