GitHub Action Guide

Automate dependency health checks on every pull request. Fail CI on critical risk before code merges.

Quick Setup

Add this workflow file to your repository at .github/workflows/depgraph.yml:

yaml

name: Dependency Health Check

on: [pull_request]

jobs:
  depgraph:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: depgraph/action@v1
        with:
          api-key: ${{ secrets.DEPGRAPH_API_KEY }}
          fail-on: critical
          post-comment: true

Add your API key as a repository secret named DEPGRAPH_API_KEY. Generate your key at Settings → API Keys.

Inputs

Input	Required	Default	Description
api-key	Yes	—	API key from dashboard (Pro plan required)
fail-on	No	critical	none \| critical \| high \| medium
post-comment	No	true	Post health report as PR comment

Outputs

Output	Description
overall-score	Project health score (0–100)
critical-count	Number of critical-risk new dependencies
high-count	Number of high-risk new dependencies
report-url	Public URL to the full scan report

Advanced Examples

Warning-only mode (no build failures)

yaml

- uses: depgraph/action@v1
  with:
    api-key: ${{ secrets.DEPGRAPH_API_KEY }}
    fail-on: none
    post-comment: true

Strict mode — fail on any medium+ risk

yaml

- uses: depgraph/action@v1
  with:
    api-key: ${{ secrets.DEPGRAPH_API_KEY }}
    fail-on: medium
    post-comment: true