Skip to main content

Sobre o gráfico de dependências

Você pode usar o gráfico de dependências para identificar todas as dependências do seu projeto. O gráfico de dependências é compatível com uma série de ecossistemas de pacotes populares.

Sobre o gráfico de dependências

The dependency graph is a summary of the manifest and lock files stored in a repository and any dependencies that are submitted for the repository using the Dependency submission API (beta). Para cada repositório, ele mostra:

  • As dependências, os ecossistemas e os pacotes do qual depende
  • Dependentes, os repositórios e pacotes que dependem dele

Ao fazer push de um commit para o GitHub Enterprise Cloud, que muda ou adiciona um manifesto compatível ou um arquivo de bloqueio para o branch-padrão, o gráfico de dependências será atualizado automaticamente. Além disso, o gráfico é atualizado quando alguém faz push de uma alteração no repositório de uma de suas dependências. Para obter informações sobre os ecossistemas compatíveis e arquivos de manifesto, consulte "ecossistemas de pacotes compatíveis" abaixo.

Additionally, you can use the Dependency submission API (beta) to submit dependencies from the package manager or ecosystem of your choice, even if the ecosystem is not supported by dependency graph for manifest or lock file analysis. O gráfico de dependência exibirá as dependências submetidas agrupadas pelo ecossistema, mas separadamente das dependências analisadas dos arquivos manifestos ou de bloqueio. Para obter mais informações sobre a API de envio de dependência, consulte "Usando a API de envio de dependência"

Ao criar um pull request que contém alterações para dependências direcionadas ao branch padrão, GitHub usará o gráfico de dependências para adicionar revisões de dependências ao pull request. Eles indicam se as dependências contêm vulnerabilidades e, em caso afirmativo, a versão da dependência na qual a vulnerabilidade foi corrigida. Para obter mais informações, consulte "Sobre a revisão de dependências".

Disponibilidade do gráfico de dependências

O gráfico de dependências está disponível para cada repositório público que define as dependências em um ecossistema de pacote compatível usando um formato de arquivo compatível. Os administradores de repositórios também podem configurar o gráfico de dependências para repositórios privados. Para obter mais informações, consulte "Configurando o gráfico de dependências.

Dependências incluídas

O gráfico de dependência inclui todas as dependências de um repositório detalhado nos arquivos de manifesto e de bloqueio, ou seu equivalente, para ecossistemas compatíveis, bem como todas as dependências que forem enviadas usando a API de envio de dependência (beta). Isto inclui:

  • As dependências diretas, que são explicitamente definidas em um arquivo manifesto ou de bloqueio ou foram enviadas usando a API (beta) de envio de dependência
  • Dependências indiretas dessas dependências diretas, também conhecidas como dependências transitórias ou subdependências

O gráfico de dependências identifica as dependências indiretas explicitamente a partir de um arquivo de bloqueio ou verificando as dependências das suas dependências diretas. Para o gráfico mais confiável, você deve usar os arquivos de bloqueio (ou o equivalente deles), pois definem exatamente quais versões das dependências diretas e indiretas você usa atualmente. Se você usar arquivos de bloqueio, você também terá certeza de que todos os contribuidores do repositório usarão as mesmas versões, o que facilitará para você testar e depurar o código.

Para obter mais informações sobre como GitHub Enterprise Cloud ajuda você a entender as dependências do seu ambiente, consulte "Sobre a segurança da cadeia de suprimentos."

Dependentes incluídos

Para repositórios públicos, apenas repositórios públicos que dependem dele ou de pacotes que publica são relatados. Essas informações não foram relatadas para repositórios privados.

Usar o gráfico de dependências

Você pode usar o gráfico de dependências para:

Ecossistemas de pacote compatíveis

Os formatos recomendados definem explicitamente quais versões são usadas para todas as dependências diretas e indiretas. Se você usar esses formatos, seu gráfico de dependências será mais preciso. Ele também reflete a configuração da criação atual e permite que o gráfico de dependências relate vulnerabilidades em dependências diretas e indiretas. As dependências indiretas, inferidas a partir de um arquivo de manifesto (ou equivalente), são excluídas das verificações de dependências inseguras.

Gerenciador de pacotesLinguagemFormatos recomendadosTodos os formatos compatíveis
CargoRustCargo.lockCargo.toml, Cargo.lock
ComposerPHPcomposer.lockcomposer.json, composer.lock
GitHub Actions workflows[†]YAML.yml, .yaml.yml, .yaml
Go modulesGogo.sumgo.mod, go.sum
MavenJava, Scalapom.xmlpom.xml
Python PoetryPythonpoetry.lockpoetry.lock, pyproject.toml
RubyGemsRubyGemfile.lockGemfile.lock, Gemfile, *.gemspec

[†] Os fluxos de trabalho de GitHub Actions devem estar localizados no diretório .github/workflows/` de um repositório a ser reconhecido como manifestos. Todas as ações ou fluxos de trabalho referenciados que usam a sintaxe `jobs[*].steps[*].uses` or `jobs..uses` serão analisados como dependências. Para obter mais informações, consulte "[Sintaxe de fluxo de trabalho para o GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions)".

[‡] Se você listar suas dependências do Python nas no arquivo setup.py, é possível que não possamos analisar e listar todas as dependências do seu projeto.

Observação: As dependências do fluxo de trabalho de GitHub Actions são exibidas no gráfico de dependências para fins informativos. Os alertas de dependência não são atualmente compatíveis com os fluxos de trabalho de GitHub Actions.

Você pode usar a API (beta) de envio de dependência para adicionar dependências do gerenciador de pacotes ou ecossistema de sua escolha ao gráfico de dependência, mesmo que o ecossistema não esteja na lista de ecossistemas compatíveis acima. O gráfico de dependência exibirá as dependências submetidas agrupadas pelo ecossistema, mas separadamente das dependências analisadas dos arquivos manifestos ou de bloqueio. Você só obterá Alertas do Dependabot para dependências que são de um dos ecossistemas compatíveis do Banco de Dados Consultivo GitHub. Para obter mais informações sobre a API de envio de dependência, consulte "Usando a API de envio de dependência"

Leia mais