I built a free GitHub Action that scores your repo health — and auto-updates your README

Source: Dev.to

How DevLens Scores Your Repo

DevLens evaluates seven weighted dimensions:

The result is a single number that tells you—and your contributors—exactly where the repo stands.

Live Badge Example

After each push, DevLens auto‑commits a badge between two markers in your README:

## Repository Health

This repository has a health score of 91.

**Repo Status:**  
- **readme**: 100  
- **activity**: 75  
- **freshness**: 100  
- **docs**: 96  
- **ci**: 100  
- **issues**: 100  
- **community**: 0

No manual updates are required; every push keeps it fresh.

Setup Guide

1. Add Markers to README.md

Place the markers where you want the badge to appear.

2. Create the Workflow

Add .github/workflows/devlens.yml:

name: DevLens Health Check

on:
  push:
    branches: [main, master]
  schedule:
    - cron: '0 8 * * 1'  # Weekly Monday digest

permissions:
  contents: write

jobs:
  devlens:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: SamoTech/devlens@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          groq_api_key: ${{ secrets.GROQ_API_KEY }}   # optional — free
          notify_discord: ${{ secrets.DISCORD_WEBHOOK }}  # optional

On the next push, DevLens scores your repo and updates the README automatically.

3. (Optional) Add a Free Groq API Key

DevLens can use Llama 3 via Groq to write a human‑readable health summary directly into your README—providing sentences that explain strengths and areas for improvement. No paid AI tier or OpenAI credits required.

4. (Optional) Set a Discord Webhook

When DISCORD_WEBHOOK is configured, every Monday at 8 am UTC your team receives a rich embed with:

• All seven dimension scores
• The overall health score
• A direct link to the repository

Perfect for passive repo‑hygiene awareness without checking dashboards.

What DevLens Looks For

• ✅ LICENSE file present
• ✅ CONTRIBUTING.md present
• ✅ CHANGELOG.md present
• ✅ CODE_OF_CONDUCT.md present
• ✅ SECURITY.md present
• ✅ docs/ folder present
• ✅ README with install, usage, features, examples, roadmap sections
• ✅ Code blocks and images in README
• ✅ 3+ GitHub Actions workflows
• ✅ 30+ commits in the last 90 days
• ✅ All issues closed (or a healthy ratio)

Roadmap (Current Status)

• 7‑dimension health score engine
• Auto README badge injection
• Weekly Discord digest
• AI README insights (Groq/Llama 3)

Future plans

• Web dashboard (Next.js)
• Email digest (Resend free tier)
• PR quality scoring
• Historical trend charts
• Multi‑repo portfolio view
• Slack integration

Get Started

If DevLens saves you time or helps your team ship better code, a ⭐ on GitHub means the world:

👉

Sponsorships are also welcome—no pressure, just love. 💛

Built with GitHub Actions + Groq + ☕ by @SamoTech