Skip to content

DOC-384: Add docs-tester.yml CI workflow for AWS docs PRs - #902

Open
quetzalliwrites wants to merge 1 commit into
mainfrom
doc-384-docs-ci-workflow-docs-testeryml-that-runs-on-every-pr-for
Open

DOC-384: Add docs-tester.yml CI workflow for AWS docs PRs#902
quetzalliwrites wants to merge 1 commit into
mainfrom
doc-384-docs-ci-workflow-docs-testeryml-that-runs-on-every-pr-for

Conversation

@quetzalliwrites

Copy link
Copy Markdown
Collaborator

Summary

Adds docs-tester.yml, the CI counterpart to agents-tester.md (merged in #813). Runs on every pull request that touches src/content/docs/aws/**.

  • Checks out the PR, diffs base→head to find the exact changed AWS doc files, and runs the tester agent against just that diff.
  • The agent reads agents-tester.md (and agents.md for context on what the writer was supposed to do), independently re-verifies the changes per that process — coverage JSON, live AWS docs, sample links, sibling doc conventions, tone — and runs the real npm run build.
  • The agent has no Edit/Write tools at all. "Report, don't fix" is enforced at the tool-permission level, not just by prompt instruction: the agent's final message is the Verification Report, and the workflow (not the agent) posts it as a PR comment via gh pr comment.
  • The agent ends its report with a VERDICT: PASS|PASS_WITH_MINOR_FINDINGS|FAIL|ESCALATE line, which the workflow parses — a FAIL or ESCALATE verdict fails the check, so this can later be wired up as a required status check (the remaining item from DOC-368: Add agents-tester.md verification agent for AWS docs #813 alongside the ANTHROPIC_API_KEY/OAuth token secret, which I assume is already set up as CLAUDE_CODE_OAUTH_TOKEN since docs-ci-agent.yml depends on it).

Mirrors docs-ci-agent.yml's conventions (Claude Code CLI install, MCP config for Linear + LocalStack, pinned action SHAs) but triggers on pull_request instead of workflow_dispatch, and reviews a diff instead of implementing a ticket.

Linear ticket

https://linear.app/localstack/issue/DOC-384/docs-ci-workflow-docs-testeryml-that-runs-on-every-pr-for-aws-docs

Test plan

  • YAML syntax validated (js-yaml parse)
  • First live run against a real AWS docs PR, to confirm the MCP config, tool restrictions, and comment-posting step all work end to end (can't fully dry-run a pull_request-triggered workflow before merge)
Runs the agents-tester.md reviewer agent on every pull request that
touches src/content/docs/aws/**. The agent independently re-verifies
the diff (coverage JSON, live AWS docs, sample links, sibling doc
conventions) and runs the real build, then posts a severity-tagged
Verification Report as a PR comment, ending with a VERDICT line the
workflow parses to decide pass/fail.

The agent is granted no Edit/Write tools at all, so "report, don't
fix" is enforced by the tool permissions themselves rather than by
prompt instruction alone: its final message text becomes the report,
and the workflow (not the agent) posts it as a PR comment via `gh pr
comment`. A FAIL or ESCALATE verdict fails the check, so this can
later be wired up as a required status check per the parent ticket
(DOC-368) and PR #813's noted follow-ups.

Mirrors docs-ci-agent.yml's conventions (Claude Code CLI, MCP config
for Linear + LocalStack, pinned action SHAs) but triggers on
pull_request instead of workflow_dispatch, and reviews rather than
implements.
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 32b94f3
Status: ✅  Deploy successful!
Preview URL: https://6ccfe55b.localstack-docs.pages.dev
Branch Preview URL: https://doc-384-docs-ci-workflow-doc.localstack-docs.pages.dev

View logs

@quetzalliwrites quetzalliwrites self-assigned this Aug 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant