무료 GitHub Action을 만들어서 repo 건강을 점수 매기고 README를 자동 업데이트합니다
Source: Dev.to
레포를 살펴보면서 “이거 정말 잘 관리되고 있는 건가, 아니면 겉만 그럴 뿐인가?” 라고 생각해 본 적 있나요?
저도 그런 생각을 너무 많이 했기에 DevLens를 만들었습니다.
DevLens는 무료 GitHub Action으로:
- 레포지토리의 건강 점수를 0부터 100까지 부여합니다.
- README에 실시간 배지를 자동으로 삽입합니다.
- 매주 분석 요약을 Discord에 전송합니다.
GitHub Actions 안에서만 실행되며, 벤더 종속성이 전혀 없습니다.
DevLens가 리포지토리를 평가하는 방법
DevLens는 일곱 가지 가중 차원을 평가합니다:
| 차원 | 가중치 | 검사 내용 |
|---|---|---|
| 📝 README 품질 | 20 % | 길이, 섹션, 배지, 코드 예시, 키워드 |
| 🔥 커밋 활동 | 20 % | 지난 90 일간 푸시 빈도 |
| 🌿 리포지토리 최신성 | 15 % | 마지막 푸시 이후 경과 일수 |
| 📚 문서화 | 15 % | LICENSE, CONTRIBUTING, CHANGELOG, CODE_OF_CONDUCT, SECURITY, docs/ 존재 여부 |
| ⚙️ CI/CD 설정 | 15 % | GitHub Actions 워크플로우 존재 여부 |
| 🎯 이슈 응답 | 10 % | 닫힌 이슈와 열린 이슈 비율 |
| ⭐ 커뮤니티 신호 | 5 % | 스타, 포크, 워처 |
결과는 하나의 숫자로, 여러분과 기여자들에게 리포지토리의 현재 상태를 정확히 알려줍니다.
실시간 배지 예시
각 푸시 후, DevLens는 README에 두 마커 사이에 배지를 자동 커밋합니다:
Repository Health
이 저장소의 건강 점수는 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.설정 가이드
1. README.md에 마커 추가
배지를 표시하고 싶은 위치에 마커를 넣으세요.
2. 워크플로우 생성
.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다음 푸시 시 DevLens가 리포지토리를 평가하고 README를 자동으로 업데이트합니다.
3. (선택 사항) 무료 Groq API 키 추가
DevLens는 Groq를 통해 Llama 3을 사용해 인간이 읽을 수 있는 건강 요약을 바로 README에 작성할 수 있습니다—강점과 개선이 필요한 부분을 설명하는 문장을 제공합니다. 별도의 유료 AI 티어나 OpenAI 크레딧이 필요하지 않습니다.
4. (선택 사항) Discord 웹훅 설정
DISCORD_WEBHOOK이 설정되어 있으면 매주 월요일 UTC 기준 오전 8시에 팀에 다음과 같은 풍부한 임베드가 전송됩니다:
- 7가지 차원 점수 모두
- 전체 건강 점수
- 리포지토리 직접 링크
대시보드를 확인하지 않아도 수동적인 레포지토리 위생 인식을 유지하는 데 최적입니다.
DevLens가 찾는 항목
- ✅
LICENSE파일 존재 - ✅
CONTRIBUTING.md존재 - ✅
CHANGELOG.md존재 - ✅
CODE_OF_CONDUCT.md존재 - ✅
SECURITY.md존재 - ✅
docs/폴더 존재 - ✅ 설치, 사용법, 기능, 예시, 로드맵 섹션을 포함한 README
- ✅ README에 코드 블록 및 이미지 포함
- ✅ 3개 이상의 GitHub Actions 워크플로우
- ✅ 지난 90 일 동안 30개 이상의 커밋
- ✅ 모든 이슈가 닫힘 (또는 건강한 비율)
로드맵 (현재 상태)
- 7‑차원 건강 점수 엔진
- 자동 README 배지 삽입
- 주간 Discord 요약
- AI README 인사이트 (Groq/Llama 3)
향후 계획
- 웹 대시보드 (Next.js)
- 이메일 요약 (Resend 무료 티어)
- PR 품질 점수 매기기
- 히스토리 트렌드 차트
- 멀티‑레포 포트폴리오 보기
- Slack 연동
시작하기
DevLens가 시간을 절약해 주거나 팀이 더 나은 코드를 배포하는 데 도움이 된다면, GitHub에 ⭐ 하나가 큰 의미가 됩니다:
👉
스폰서십도 환영합니다—압박은 없고, 단지 사랑을 전합니다. 💛
GitHub Actions + Groq + ☕ 로 @SamoTech가 제작