Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais atualizadas, acesse a documentação em inglês.
O controle de versão da API REST já foi feito. Para obter mais informações, confira "Sobre o controle de versão da API".

Envio de dependência

Use a API REST para enviar dependências.

Sobre os envios de dependências

Observação: a capacidade de usar a API REST para envio de dependência está atualmente em versão beta pública e sujeita a alterações.

Você pode usar a API REST para enviar dependências para um projeto. Isso permite que você adicione dependências, como aquelas resolvidas quando o software é compilado ou criado, ao recurso de gráfico de dependências do GitHub, fornecendo uma visão mais completa de todas as dependências do seu projeto.

O gráfico mostra todas as dependências que você envia usando a API, além de quaisquer dependências identificadas por meio de arquivos de manifesto ou de bloqueio no repositório (por exemplo, um arquivo package-lock.json em um projeto JavaScript). Para obter mais informações sobre exibição do grafo de dependência, confira "Explorar as dependências de um repositório".

As dependências enviadas receberão Dependabot alerts e Dependabot security updates para quaisquer vulnerabilidades conhecidas. Você só obterá Dependabot alerts para dependências que são de um dos ecossistemas com suporte do GitHub Advisory Database. As dependências enviadas não serão exibidas na revisão de dependência ou nas informações de dependência da sua organização.

É possível enviar dependências na forma de um instantâneo. Um instantâneo é um conjunto de dependências associadas a um SHA de commit e a outros metadados, que reflete o estado atual do repositório de um commit. É possível optar por usar ações predefinidas ou criar suas próprias ações para enviar suas dependências no formato necessário sempre que seu projeto for criado. Para obter mais informações, confira "Como usar a API de envio de dependência".

É possível enviar diversos conjuntos de dependências para serem incluídos em seu grafo de dependência. A API REST usa a propriedade job.correlator e a categoria detector.name do instantâneo para garantir que os envios mais recentes para cada fluxo de trabalho sejam exibidos. A propriedade correlator em si é o campo primário que você usará para diferenciar os envios independentes. Um correlator de exemplo pode ser uma combinação simples de duas variáveis disponíveis em execuções de ações: <GITHUB_WORKFLOW> <GITHUB_JOB>.

Create a snapshot of dependencies for a repository

Funciona com 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 para "Create a snapshot of dependencies for a repository"

Cabeçalhos
Name, Tipo, Descrição
accept string

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

Parâmetros de caminho
Name, Tipo, Descrição
owner string Obrigatório

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

repo string Obrigatório

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

Parâmetros do corpo
Name, Tipo, Descrição
version integer Obrigatório

The version of the repository snapshot submission.

job object Obrigatório
Name, Tipo, Descrição
id string Obrigatório

The external ID of the job.

correlator string Obrigató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_url string

The url for the job.

sha string Obrigatório

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

ref string Obrigatório

The repository branch that triggered this snapshot.

detector object Obrigatório

A description of the detector used.

Name, Tipo, Descrição
name string Obrigatório

The name of the detector used.

version string Obrigatório

The version of the detector used.

url string Obrigatório

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.

Name, Tipo, Descrição
key object

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

Name, Tipo, Descrição
name string Obrigatório

The name of the manifest.

file object
Name, Tipo, Descrição
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.

Name, Tipo, Descrição
key object

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

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

Pode ser um dos: 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.

Pode ser um dos: runtime, development

dependencies array of strings

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

scanned string Obrigatório

The time at which the snapshot was scanned.

Códigos de status de resposta HTTP para "Create a snapshot of dependencies for a repository"

Código de statusDescrição
201

Created

Exemplos de código para "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" }