dependents.info
easily generate an image of github network dependents to showcase in
your project's readme.md file.
simply add a github action to your repository and use the image link for your repo.
demo
here's a demo of the generated image:
quickstart
github action
add this file to your repository's .github/workflows folder.
dependents.yml
once you push this file, the action will process the dependents for the repository and the backend will generate the image.
tip: instead of running the action on push, you can use a
cron job
to schedule the action.
configuration (optional)
add the following options to your dependents.yml file if you want to customize the action's behavior:
| option | type | description | default |
|---|---|---|---|
max-pages |
number |
Maximum number of network dependents pages to process (max: 100) | 50 |
unique-owners |
boolean |
Whether to disable unique users in the generated image | true |
exclude-owner |
boolean |
Whether to exclude repos from the same owner that depend on this repository | true |
upload-artifacts |
boolean |
Whether to upload the outputs as action's build artifacts | false |
embed image
note: the image is only available for repositories that run the action successfully.
enter your github repository name in the format owner/repo
to generate a copyable embed code.
paste this code anywhere in the readme and the auto-generated dependents image will be embedded!
the image is self updating so when the github action submits new data, it will be reflected in the readme automatically.
note: in addition to cloudflare's cache lasting up to a day, the image could be cached by github for an extended 7 day period. please refer to the docs on how to manually purge it if required.