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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
# AI Documentation Validation
#
# Install this workflow into vyos/vyos-documentation at:
# .github/workflows/ai-validation.yml
#
# Required secrets in vyos/vyos-documentation:
# ANTHROPIC_API_KEY — Anthropic API key for Claude
# VYOS_APP_ID — GitHub App ID (created by scripts/create-github-app.sh)
# VYOS_APP_PRIVATE_KEY — GitHub App private key (PEM)
#
# The GitHub App must be installed on BOTH orgs:
# - VyOS-Networks: access to vyos-1x, vyos-docs-opus-reviewer
# - vyos: access to vyos-documentation (for PR context)
#
# Required: reference DB must be pre-built in VyOS-Networks/vyos-docs-opus-reviewer
# (runs automatically every Sunday, or trigger manually via rebuild-reference.yml)
name: AI Validation
on:
pull_request:
types: [opened, synchronize, reopened]
jobs:
validate:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
id-token: write
steps:
- name: Check secrets availability
id: secrets-check
run: |
if [ -z "${{ secrets.VYOS_APP_ID }}" ] || \
[ -z "${{ secrets.VYOS_APP_PRIVATE_KEY }}" ] || \
[ -z "${{ secrets.ANTHROPIC_API_KEY }}" ]; then
echo "skip=true" >> "$GITHUB_OUTPUT"
echo "::notice::Skipping AI validation — required secrets not available"
else
echo "skip=false" >> "$GITHUB_OUTPUT"
fi
- name: Generate GitHub App token
if: steps.secrets-check.outputs.skip != 'true'
id: app-token
uses: actions/create-github-app-token@v1
with:
app-id: ${{ secrets.VYOS_APP_ID }}
private-key: ${{ secrets.VYOS_APP_PRIVATE_KEY }}
owner: VyOS-Networks
repositories: vyos-1x,vyos-docs-opus-reviewer
- name: Determine target branch
if: steps.secrets-check.outputs.skip != 'true'
id: branch
run: |
TARGET="${{ github.event.pull_request.base.ref }}"
echo "target=$TARGET" >> "$GITHUB_OUTPUT"
echo "Validating against vyos-1x branch: $TARGET"
- name: Checkout PR
if: steps.secrets-check.outputs.skip != 'true'
uses: actions/checkout@v6
with:
fetch-depth: 1
- name: Checkout vyos-1x (matching branch, private)
if: steps.secrets-check.outputs.skip != 'true'
uses: actions/checkout@v6
with:
repository: vyos-networks/vyos-1x
ref: ${{ steps.branch.outputs.target }}
path: .vyos-1x
fetch-depth: 1
token: ${{ steps.app-token.outputs.token }}
- name: Download reference DB (matching branch)
if: steps.secrets-check.outputs.skip != 'true'
id: download-db
continue-on-error: true
uses: robinraju/release-downloader@v1
with:
repository: VyOS-Networks/vyos-docs-opus-reviewer
latest: true
fileName: "reference-db-${{ steps.branch.outputs.target }}.tar.gz"
out-file-path: .reference-db
token: ${{ steps.app-token.outputs.token }}
- name: Extract reference DB
if: steps.secrets-check.outputs.skip != 'true' && steps.download-db.outcome == 'success'
id: extract-db
run: |
mkdir -p .reference-db/extracted
tar -xzf .reference-db/reference-db-${{ steps.branch.outputs.target }}.tar.gz -C .reference-db/extracted
- name: Skip notice (no reference DB)
if: steps.secrets-check.outputs.skip != 'true' && steps.download-db.outcome != 'success'
run: |
echo "::warning::Reference DB not found for branch '${{ steps.branch.outputs.target }}'. Skipping Pass 1 deterministic checks."
echo '[]' > pass1-findings.json
- name: Setup Python
if: steps.secrets-check.outputs.skip != 'true'
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install reviewer
if: steps.secrets-check.outputs.skip != 'true'
run: |
pip install "git+https://x-access-token:${{ steps.app-token.outputs.token }}@github.com/VyOS-Networks/vyos-docs-opus-reviewer.git"
- name: Save PR diff
if: steps.secrets-check.outputs.skip != 'true'
run: gh pr diff ${{ github.event.pull_request.number }} > pr-diff.txt
env:
GH_TOKEN: ${{ github.token }}
- name: Pass 1 — deterministic checks
if: steps.secrets-check.outputs.skip != 'true' && steps.download-db.outcome == 'success'
run: |
vyos-doc-review pass1 \
--pr-diff pr-diff.txt \
--reference-db .reference-db/extracted \
--output pass1-findings.json
- name: Pass 2 — Claude review
if: steps.secrets-check.outputs.skip != 'true'
uses: anthropics/claude-code-action@v1
with:
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
model: claude-opus-4-6
track_progress: true
prompt: |
You are a VyOS documentation reviewer. Your job is to verify documentation
accuracy against the VyOS codebase.
## Context
REPO: ${{ github.repository }}
PR NUMBER: ${{ github.event.pull_request.number }}
TARGET BRANCH: ${{ steps.branch.outputs.target }}
The PR branch is checked out in the current directory (vyos-documentation).
The vyos-1x source tree is at `.vyos-1x/` (branch: ${{ steps.branch.outputs.target }}).
If `.reference-db/extracted/` exists, it contains the pre-built reference
database. If that directory is missing, the reference DB was unavailable for
this branch and Pass 1 was skipped.
IMPORTANT: This PR targets the **${{ steps.branch.outputs.target }}** branch.
The vyos-1x checkout matches this branch. Features may differ between branches
(e.g., a command exists in `current` but not in `sagitta`). Only flag issues
relevant to this specific branch.
## Pass 1 Findings
`pass1-findings.json` contains deterministic check results. If the reference
DB was unavailable, this file may be empty or contain no findings — in that
case, rely on direct source inspection in `.vyos-1x/` instead.
## Your Tasks
1. Read `pass1-findings.json` if it contains findings.
2. For HIGH confidence findings: post inline comments on the PR.
3. For MEDIUM/LOW confidence findings, or if Pass 1 was skipped: read the
actual source files in `.vyos-1x/` to verify. Classify each as:
- CONFIRMED ISSUE — post inline comment with evidence
- FALSE POSITIVE — skip
- NEEDS HUMAN — include in summary with explanation
4. Review the changed RST sections for behavioral claims. Cross-reference
against the conf_mode/op_mode Python scripts in `.vyos-1x/src/`.
5. Post a summary comment with two sections:
- **Issues**: confirmed problems with severity (ERROR/WARNING/INFO)
- **Needs Verification**: ambiguous findings requiring human review
- **Stats**: files reviewed, commands checked, branch reviewed
## Finding Format
For inline comments, use this structure:
```
{SEVERITY} — {short description}
Doc says: {what the doc claims}
Source ({file}:{line}): {what the source says}
Branch: ${{ steps.branch.outputs.target }}
{suggestion for fix}
```
## Review Criteria
- CLI paths must exist in XML interface definitions
- Default values must match XML `<defaultValue>` or Python `default_value()` calls
- Parameter options must match `<completionHelp>` and `<constraint>` definitions
- Behavioral descriptions must match conf_mode script logic
- Referenced features must not be removed or renamed
- Severity: ERROR (factually wrong), WARNING (misleading/incomplete), INFO (improvement)
claude_args: |
--allowedTools "mcp__github_inline_comment__create_inline_comment,Bash(gh pr comment:*),Bash(gh pr diff:*),Bash(gh pr view:*),Read,Glob,Grep"
|
