Coding-agent integration guide

Use this guide when asked to integrate PR Agent into a GitHub repository.

Inspect the repository

1. Find the default branch and existing pull-request workflows.
2. Identify the project’s language, package manager, and current CI validation command.
3. Use the project’s real deterministic test command. Do not replace it with true.

Add the reusable workflow caller

Create .github/workflows/pr-agent.yml:

name: PR Agent

on:
  pull_request:
    types: [opened, synchronize, reopened]

permissions:
  contents: write
  pull-requests: write

jobs:
  agent:
    uses: zc6600/agentic-swe/.github/workflows/pr-agent.yml@main
    with:
      validation-command: npm test
    secrets:
      OPENROUTER_API_KEY: ${{ secrets.OPENROUTER_API_KEY }}
      PR_AGENT_TOKEN: ${{ secrets.PR_AGENT_TOKEN }}

Replace npm test with the command found in the repository. Keep the explicit secret mappings and the reusable workflow’s same-repository guard.

Preserve the secret boundary

• Never ask the user to paste secret values into files or chat.
• Do not add secret values to workflow YAML, logs, or commits.
• Tell the maintainer to add OPENROUTER_API_KEY and PR_AGENT_TOKEN in repository Actions settings.
• Tell the maintainer to enable auto-merge and required branch checks.

Verify and report

Parse the workflow YAML and run the repository’s relevant configuration checks. Report the workflow path, selected validation command, and the human-only settings that remain.