{
 "schema_version": 1,
 "generated": "2026-10-26",
 "id": "vuphongle-oss-pr-reviewer--get-json-review-findings-for-ci",
 "repo": "vuphongle/oss-pr-reviewer",
 "repo_url": "https://github.com/vuphongle/oss-pr-reviewer",
 "repo_slug": "vuphongle-oss-pr-reviewer",
 "title": "Export review findings as JSON for a CI step",
 "page_title": "How to export review findings as JSON for a CI step with OSS PR Reviewer",
 "summary": "Write a machine-readable review of a pull request so a pipeline can read the results.",
 "who": "A maintainer or DevOps engineer who wants a CI job to read review results from a pull request without parsing Markdown.",
 "problem": "A Markdown report is easy for people to read but hard for a pipeline to act on consistently.",
 "outcome": "A review.json file produced by the CLI that a later CI script can parse, while the final decision stays with a human.",
 "steps": [
  "Run `npm install` and `npm run build` in the checkout.",
  "Set `GITHUB_TOKEN` and `OPENAI_API_KEY` in the CI secret store and export them for the job.",
  "Run `node dist/cli/index.js review --repo owner/repository --pr 123 --output review.json --output-format json`.",
  "Have the next CI step read review.json and report the findings, without failing the build on a high or critical finding alone."
 ],
 "agent_prompt": "In the oss-pr-reviewer checkout, run node dist/cli/index.js review --repo <owner/repository> --pr <number> --output review.json --output-format json. Verify that review.json parses as JSON and summarize the findings by severity. Do not treat a high or critical finding as a merge decision.",
 "agents": [
  "any"
 ],
 "difficulty": "Advanced",
 "time": "45 minutes",
 "basis": "readme",
 "caveat": "The README says a high or critical finding does not make the process fail, so your CI step must add its own rule if you want a gate.",
 "category": "Software and DevOps",
 "tags": [
  "Software and DevOps"
 ],
 "lang": "typescript",
 "requirements": [
  "Node.js 20 LTS or newer",
  "A checkout of the vuphongle/oss-pr-reviewer repository",
  "An OpenAI API key set as OPENAI_API_KEY (required for live reviews)",
  "A GITHUB_TOKEN is recommended to avoid anonymous GitHub API rate limits",
  "Network access to GitHub and OpenAI"
 ],
 "risk": "sensitive",
 "seen_in_the_wild": false,
 "mentioned_publicly": false,
 "risks": [
  {
   "tag": "credentials",
   "notice": "Store the OpenAI and GitHub keys as CI secrets and avoid echoing them in job logs."
  }
 ],
 "best": false,
 "score": 0.9,
 "evidence": [],
 "url": "https://dedupedai.com/use-cases/vuphongle-oss-pr-reviewer/get-json-review-findings-for-ci/",
 "md": "https://dedupedai.com/use-cases/vuphongle-oss-pr-reviewer/get-json-review-findings-for-ci/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/vuphongle-oss-pr-reviewer--get-json-review-findings-for-ci.json",
 "api_version": "v1"
}
