Skip to content

Better explanation for "Used by" section #15750

Closed
@chamini2

Description

@chamini2

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository#dependents-view

What part(s) of the article would you like to see updated?

I think the process to getting your package recognized from GitHub is not really explained, it says

If the dependency graph is enabled, and your repository contains a package that's published on a supported package ecosystem, GitHub displays a "Used by" section in the sidebar of the Code tab of your repository. For more information about the supported package ecosystems, see "About the dependency graph."

But then when checking the About the dependency graph link, it only states how to parse DEPENDENCIES of a project, not how to get your project recognized as a possible dependency.

Additional information

Click to show the information used to debug this issue...

Currently I am trying to get a public repo of a PyPI library to show the Used by section and I have had no luck on making it pick up the package.

image

Update from a maintainer

Content changes needed

  1. Dependencies view - update the first paragraph to make it clear that links are only shown if the package manager for the dependency links to the source code in a public repository on GitHub.
  2. Changing the "Used by" package - revise the first paragraph to make it clear that the "Used by" section is shown only if:
    • Your repository contains a package that's published on a supported ecosystem.
    • In the ecosystem, your package has a link to the a public repository in GitHub where the source is stored.
    • Dependency graph is enabled for the repository.

Metadata

Metadata

Assignees

Labels

MLH fellowshipThis issue is reserved for the MLH Fellowship programcode securityContent related to code securitycontentThis issue or pull request belongs to the Docs Content team

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions