{
 "schema_version": 1,
 "generated": "2026-10-30",
 "id": "winnin-farol--add-farol-to-every-pull-request-with-the-github-action",
 "repo": "winnin/farol",
 "repo_url": "https://github.com/winnin/farol",
 "repo_slug": "winnin-farol",
 "title": "Comment a merge risk report on every pull request in CI",
 "page_title": "How to comment a merge risk report on every pull request in CI with Farol",
 "summary": "Run Farol on every PR with the winnin/farol/action GitHub Action, fed by your existing coverage and lint reports.",
 "who": "A team lead who wants low-risk PRs to go fast and risky ones flagged automatically.",
 "problem": "Without triage, every PR gets the same light review regardless of how much it can break.",
 "outcome": "A Farol comment on each PR with the verdict, score, breaking contract changes and uncovered lines.",
 "steps": [
  "Add the GitHub Action `winnin/farol/action` to your PR workflow",
  "Point it at the coverage, lint, security and audit reports your CI already produces",
  "Open a test PR and read the comment: full PR report plus commits since the last push",
  "It never blocks a merge; decide your own rule for careful review verdicts",
  "For local runs, `npm install --global @winninjs/farol` gives a plain Farol command"
 ],
 "agent_prompt": "Add winnin/farol's GitHub Action (winnin/farol/action) to this repo's PR workflow, feed it our coverage and lint reports, and open a test PR to confirm it comments a verdict.",
 "agents": [
  "claude-code",
  "codex"
 ],
 "difficulty": "Intermediate",
 "time": "30 minutes",
 "basis": "readme",
 "caveat": "",
 "category": "Software and DevOps",
 "tags": [
  "Software and DevOps"
 ],
 "lang": "typescript",
 "requirements": [
  "Node.js 22+ and git",
  "go for Go projects, python3 3.11+ for Python projects",
  "Optional: coverage, lint and audit reports from your CI"
 ],
 "risk": "none",
 "seen_in_the_wild": false,
 "mentioned_publicly": false,
 "risks": [],
 "best": false,
 "score": 0.8,
 "evidence": [],
 "url": "https://dedupedai.com/use-cases/winnin-farol/add-farol-to-every-pull-request-with-the-github-action/",
 "md": "https://dedupedai.com/use-cases/winnin-farol/add-farol-to-every-pull-request-with-the-github-action/index.md",
 "disclaimer": "Deduped lists open-source repositories that belong to other people. We do not own, maintain, audit, or vouch for any of them, and a repo appearing here is not an endorsement or a safety check. The use cases, steps, and prompts are written by AI and may be incomplete, outdated, or just wrong. Where a use case is marked \"Seen in the wild\", we link to public posts where someone described something similar, but we have not verified those posts and the use case itself is still our AI's own write-up. Use all of this at your own risk. Only run code, commands, or agents on systems and accounts you are authorized to use, and read the code and every command before you run it, especially anything that touches credentials, files, or the network. Nothing here is professional, security, legal, or financial advice. All trademarks and project names belong to their respective owners, and their use here does not imply affiliation. Content is provided as is, without warranties of any kind. Found a mistake, a safety problem, or something you want removed? Email hello@dedupedai.com and we will look at it promptly.",
 "api": "https://dedupedai.com/api/v1/usecases/winnin-farol--add-farol-to-every-pull-request-with-the-github-action.json",
 "api_version": "v1"
}