-
Notifications
You must be signed in to change notification settings - Fork 0
58 lines (48 loc) · 2.27 KB
/
claude-code-review.yml
File metadata and controls
58 lines (48 loc) · 2.27 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
name: Claude Code Review
# Auto-reviews every docs PR for accuracy, broken links, consistency, and
# house style. Mirrors the reviewer in the DOS.AI code repo, retuned for a
# documentation repo (no build/tests to reason about). Uses the org secret
# CLAUDE_CODE_OAUTH_TOKEN.
on:
pull_request:
types: [opened, synchronize]
jobs:
claude-review:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: read
issues: read
id-token: write
steps:
- name: Checkout repository
uses: actions/checkout@v6
with:
fetch-depth: 1
- name: Run Claude Code Review
id: claude-review
uses: anthropics/claude-code-action@v1
with:
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
prompt: |
REPO: ${{ github.repository }}
PR NUMBER: ${{ github.event.pull_request.number }}
This is a documentation repository (GitBook Markdown for the
DOS.AI developer docs). Review this pull request for:
- Factual accuracy: do API base URLs, endpoint paths, auth
schemes, request/response shapes, and code samples match the
actual product? Flag anything that looks stale or invented.
- Broken or wrong links: internal page links and external URLs.
- Consistency: terminology, endpoint naming, and auth examples
should agree across pages (e.g. an endpoint documented one way
on the overview must match the reference page).
- House style: user-facing text uses ASCII hyphens only - flag
any em-dash (—) or en-dash (–).
- Completeness: new endpoints/parameters documented; deprecated
ones marked.
Use the repository's README / SUMMARY.md for structure and any
CLAUDE.md for conventions. Be constructive and specific (cite the
file + line). Do NOT rewrite the docs; just review.
Use `gh pr comment` with your Bash tool to leave your review as a
comment on the PR.
claude_args: '--allowed-tools "Bash(gh issue view:*),Bash(gh search:*),Bash(gh issue list:*),Bash(gh pr comment:*),Bash(gh pr diff:*),Bash(gh pr view:*),Bash(gh pr list:*)"'