You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/workflows/doc-check.yaml
+20-46Lines changed: 20 additions & 46 deletions
Original file line number
Diff line number
Diff line change
@@ -203,61 +203,35 @@ jobs:
203
203
;;
204
204
esac
205
205
206
-
# Build chat prompt with sticky comment logic
206
+
# Build the chat prompt. Durable rules live in the skill
207
+
# (.claude/skills/doc-check/SKILL.md), so this prompt stays short
208
+
# and carries only what changes per run.
207
209
CHAT_PROMPT="Use the doc-check skill to review PR #${PR_NUMBER} in coder/coder.
208
210
209
211
${CONTEXT}
210
212
211
-
When creating a new workspace, use the \"coder-workflow-bot\" template.
213
+
Use \`gh\` to read the PR details, the diff, and every comment.
212
214
213
-
If a tool call fails with \`get workspace agents in latest build: unauthorized: rbac: forbidden\`, this chat has no working workspace. That is an infrastructure state, not a mistake in your command, so the same command fails again if you retry it.
215
+
Follow the skill in full: its evidence discipline, its comment
216
+
rules, and its comment format. **Do not comment if no
217
+
documentation changes are needed.**
214
218
215
-
Call \`start_workspace\` with no arguments to start the workspace this chat owns. If it answers \`workspace was deleted\` or \`chat has no workspace\`, the old one is gone: call \`list_templates\` to get the ID of the \`coder-workflow-bot\` template, then call \`create_workspace\` with that ID. Wait for the workspace to be ready, then run the failed tool call again.
219
+
## When the workspace is broken
216
220
217
-
If \`start_workspace\` answers \`load workspace: unauthorized: rbac: forbidden\`, the workspace is dormant and you cannot repair it. Stop there.
221
+
A tool call that fails with \`unauthorized: rbac: forbidden\` is an
222
+
infrastructure state, not a bad command, so retrying the same
223
+
command changes nothing.
218
224
219
-
When you cannot repair the workspace, say that you could not review the PR, and name the error you got. Post no doc-check comment. Do not say or imply the docs are fine, because you did not read them.
225
+
Call \`start_workspace\` with no arguments. If it answers
226
+
\`workspace was deleted\` or \`chat has no workspace\`, call
227
+
\`list_templates\` for the \`coder-workflow-bot\` template ID, then
228
+
\`create_workspace\` with it, and run the failed call again. If it
229
+
answers \`load workspace: unauthorized: rbac: forbidden\`, the
230
+
workspace is dormant and you cannot repair it: stop, say you could
231
+
not review the PR, and name the error. Post no comment, and do not
232
+
imply the docs are fine, because you did not read them.
220
233
221
-
Use \`gh\` to get PR details, diff, and all comments. Look for an existing doc-check comment containing \`<!-- doc-check-sticky -->\` - if one exists, you'll update it instead of creating a new one.
222
-
223
-
Follow the skill's evidence discipline, including its mandatory
224
-
search: list every literal this diff changes, then search the whole
225
-
docs tree for each OLD literal before you decide. Do not review only
226
-
the files in the diff. Report each search you ran and what it
227
-
returned, and post nothing only after every search came back empty
228
-
outside \`docs/reference/\`.
229
-
230
-
**Do not comment if no documentation changes are needed.**
231
-
232
-
If a sticky comment already exists, compare your current findings against it:
233
-
- Check off \`[x]\` items that are now addressed
234
-
- Strikethrough items no longer needed (e.g., code was reverted)
235
-
- Add new unchecked \`[ ]\` items for newly discovered needs
236
-
- If an item is checked but you can't verify the docs were added, add a warning note below it
237
-
- If nothing meaningful changed, don't update the comment at all
238
-
239
-
## Comment format
240
-
241
-
Use this structure (only include relevant sections):
242
-
243
-
\`\`\`
244
-
## Documentation Check
245
-
246
-
### Updates Needed
247
-
- [ ] \`docs/path/file.md\` - What needs to change
248
-
- [x] \`docs/other/file.md\` - This was addressed
249
-
- ~~\`docs/removed.md\` - No longer needed~~ *(reverted in abc123)*
250
-
251
-
### New Documentation Needed
252
-
- [ ] \`docs/suggested/path.md\` - What should be documented
253
-
> ⚠️ *Checked but no corresponding documentation changes found in this PR*
254
-
255
-
---
256
-
*Automated review via [Coder Agents](https://coder.com/docs/ai-coder/agents)*
257
-
<!-- doc-check-sticky -->
258
-
\`\`\`
259
-
260
-
The \`<!-- doc-check-sticky -->\` marker must be at the end so future runs can find and update this comment."
234
+
Create any new workspace from the \"coder-workflow-bot\" template."
0 commit comments