Skip to content

about-the-dependency-graph.md

Latest commit

 

History

History
94 lines (64 loc) · 7.78 KB

about-the-dependency-graph.md

File metadata and controls

94 lines (64 loc) · 7.78 KB
title About the dependency graph
intro You can use the dependency graph to identify all your project's dependencies. The dependency graph supports a range of popular package ecosystems.
product {% data reusables.gated-features.dependency-graph %}
redirect_from
/github/visualizing-repository-data-with-graphs/about-the-dependency-graph
/code-security/supply-chain-security/about-the-dependency-graph
/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph
versions
fpt ghes ghec
*
*
*
topics
Dependency graph
Dependencies
Repositories
shortTitle Dependency graph
contentType concepts

About the dependency graph

{% data reusables.dependabot.about-the-dependency-graph %}

When you push a commit to {% data variables.product.github %} that changes or adds a supported manifest or lock file to the default branch, the dependency graph is automatically updated.{% ifversion fpt or ghec %} In addition, the graph is updated when anyone pushes a change to the repository of one of your dependencies.{% endif %}

For information on the supported ecosystems and manifest files, see AUTOTITLE.

{% data reusables.dependency-submission.dependency-submission-link %}

When you create a pull request containing changes to dependencies that targets the default branch, {% data variables.product.prodname_dotcom %} uses the dependency graph to add dependency reviews to the pull request. These indicate whether the dependencies contain vulnerabilities and, if so, the version of the dependency in which the vulnerability was fixed. For more information, see AUTOTITLE.

Dependency graph availability

{% ifversion fpt or ghec %} {% data reusables.dependency-graph.feature-availability %} For more information, see AUTOTITLE.

{% data reusables.dependency-graph.feature-availability %} See AUTOTITLE.

{% endif %}

{% data reusables.dependabot.dependabot-alerts-dependency-graph-enterprise %}

{% ifversion ghes %} For more information about configuration of the dependency graph, see AUTOTITLE.{% endif %}

Dependencies included

The dependency graph includes all the dependencies of a repository that are detailed in the manifest and lock files, or their equivalent, for supported ecosystems, as well as any dependencies that are submitted using the {% data variables.dependency-submission-api.name %}. This includes:

  • Direct dependencies, that are explicitly defined in a manifest or lock file or have been submitted using the {% data variables.dependency-submission-api.name %}
  • Indirect dependencies of these direct dependencies, also known as transitive dependencies or sub-dependencies

The dependency graph identifies indirect dependencies{% ifversion fpt or ghec %} only if they are defined in a lock file or have been submitted using the {% data variables.dependency-submission-api.name %}. For the most reliable graph, you should use lock files (or their equivalent) because they define exactly which versions of the direct and indirect dependencies you currently use. If you use lock files, you also ensure that all contributors to the repository are using the same versions, which will make it easier for you to test and debug code{% else %} from the lock files{% endif %}. If your ecosystem does not have lock files, you can use pre-made actions that resolve transitive dependencies for many ecosystems. For more information, see AUTOTITLE.

For more information on how {% data variables.product.github %} helps you understand the dependencies in your environment, see AUTOTITLE.

{% ifversion fpt or ghec %}

Dependents and "used by" data

For public repositories, the dependency graph lists dependents. These are other public repositories that depend on the repository or on packages that it publishes. This information is not reported for private repositories.

{% data reusables.dependency-graph.used-by %} Clicking any item in this section takes you to the Dependents tab of the dependency graph.

Your repository will have a "Used by" section if:

  • The dependency graph is enabled for the repository.
  • Your repository contains a package that is published on a supported package ecosystem. See AUTOTITLE.
  • Within the ecosystem, your package has a link to a public repository where the source is stored.
  • More than 100 repositories depend on your package.

Screenshot of the "Used by" section for a repository showing the summary of "13.4m" with details of 8 avatars and "+13,435,819."

The "Used by" section represents a single package from the repository. If you have admin permissions to a repository that contains multiple packages, you can choose which package the "Used by" section represents. See AUTOTITLE.

{% endif %}

What you can do with the dependency graph

You can use the dependency graph to:

  • Explore the repositories your code depends on{% ifversion fpt or ghec %}, and those that depend on it{% endif %}. For more information, see AUTOTITLE. {% ifversion fpt or ghec %}
  • View a summary of the dependencies used in your organization's repositories in a single dashboard. For more information, see AUTOTITLE.{% endif %}
  • View and update vulnerable dependencies for your repository. For more information, see AUTOTITLE.
  • See information about vulnerable dependencies in pull requests. For more information, see AUTOTITLE.
  • Export a software bill of materials (SBOM) for audit or compliance purposes. This is a formal, machine-readable inventory of a project's dependencies. See AUTOTITLE.

Further reading