Skip to Content
Health ReportsUse CasesWeekly Slack Report

Weekly Slack Report

Get automated codebase health summaries delivered to your Slack channels every time CI runs — dependencies, bundle size, unused code, and security findings in one readable message.

What you’ll get

Each report includes deltas against the previous snapshot:

  • Dependencies — Package count changes and vulnerability summary
  • Bundle size — Total size change and top route regressions
  • Unused code — Unused files and dependencies detected by Knip
  • Security — CVE findings from your lockfile (when enabled)

Setup

Connect Slack

  1. Go to Organization Settings → Slack in the Dev Herald dashboard
  2. Click Connect Slack and authorize the Dev Herald bot for your workspace

Subscribe a channel

  1. In Slack, go to the channel where you want reports (e.g., #engineering-health)
  2. Mention @Dev Herald and follow the prompts to subscribe the channel to your project
  3. Dev Herald confirms the subscription and posts the latest available report

Add a scheduled CI workflow

Run health collection on a schedule so your team gets regular updates:

name: Health
 
on:
  schedule:
    - cron: '0 9 * * 1'  # Every Monday at 9:00 UTC
  workflow_dispatch:
 
jobs:
  health:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      # ... install dependencies, run Knip, etc.
 
      - name: Upload health data
        uses: dev-herald/health@v1
        with:
          api-key: ${{ secrets.DEV_HERALD_API_KEY }}
          knip-report-path: results.json
          lockfile-path: ${{ github.workspace }}/pnpm-lock.yaml
          workflow-run-url: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}

How delivery works

  1. CI completes and POSTs health signals to Dev Herald
  2. Dev Herald stores the report and compares it against the previous snapshot
  3. If the project has a subscribed Slack channel, a formatted summary is posted automatically
  4. Each report is marked as delivered after a successful post — undelivered reports are retried on the next subscription or ingest

Tips

  • Run on a weekly schedule (cron: '0 9 * * 1') for a consistent Monday morning digest
  • Include workflow-run-url so team members can jump to the CI run from Slack
  • Subscribe different channels for different projects if you have multiple repositories

Next steps

Last updated on
SignalsSecurity Report