mirror of
https://github.com/docker/docs.git
synced 2026-03-27 14:28:47 +07:00
9919609453
pr-review: drop pull_request_target (auto-review on open/ready_for_review). Manual /review via issue_comment is preserved and unaffected. labeler: replace pull_request_target with workflow_dispatch to disable automatic fork-PR labeling. Can be re-enabled by reverting this change. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
76 lines
3.1 KiB
YAML
76 lines
3.1 KiB
YAML
name: PR Review
|
|
|
|
on:
|
|
issue_comment:
|
|
types: [created]
|
|
pull_request_review_comment:
|
|
types: [created]
|
|
|
|
permissions:
|
|
contents: read
|
|
pull-requests: write
|
|
issues: write
|
|
|
|
jobs:
|
|
review:
|
|
uses: docker/cagent-action/.github/workflows/review-pr.yml@3a12dbd0c6cd7dda3d4e05f24f0143c9701456de # latest
|
|
secrets: inherit
|
|
with:
|
|
add-prompt-files: STYLE.md,COMPONENTS.md
|
|
additional-prompt: |
|
|
## Documentation Review Focus
|
|
|
|
This is Docker's official documentation.
|
|
You are reviewing **DOCUMENTATION**, not code. Focus on documentation quality, not software bugs.
|
|
|
|
**Style guides are available via prompt files (STYLE.md, COMPONENTS.md)** - reference them when evaluating changes.
|
|
|
|
## Priority Issues
|
|
|
|
### 1. Vendored/Generated Content (CRITICAL - Auto-reject)
|
|
Flag if changes touch:
|
|
- Any file in `_vendor/` directory (vendored from upstream repos)
|
|
- Any YAML file in `data/*/*.yaml` subdirectories (CLI reference data generated from upstream)
|
|
- Examples: `data/engine-cli/*.yaml`, `data/buildx/*.yaml`, `data/scout-cli/*.yaml`
|
|
- Exception: root-level data/ files are manually maintained (allow edits)
|
|
|
|
### 2. Missing Redirects When Removing/Moving Pages (HIGH)
|
|
When a PR removes or moves a page:
|
|
- Check if the PR adds an `aliases:` entry in the front matter of the target/replacement page
|
|
- Example: If `/old/path.md` is removed, there should be `aliases: ["/old/path/"]` in the new page
|
|
|
|
### 3. Markdown Formatting
|
|
- Poor markdown syntax (unclosed code blocks, broken lists, indentation issues, etc.)
|
|
- Line wrapping over 80 characters (except links, code blocks, tables)
|
|
|
|
### 4. AI-Generated Patterns (HIGH PRIORITY)
|
|
Flag AI-isms from STYLE.md:
|
|
- Hedge words: simply, just, easily, quickly, seamlessly
|
|
- Redundant phrases: "in order to", "allows you to"
|
|
- Meta-commentary: "it's worth noting that"
|
|
- Marketing speak: "robust", "powerful", "cutting-edge"
|
|
- Passive voice: "is used by" → "uses"
|
|
|
|
### 5. Scope Preservation
|
|
Does the change match existing document's length and tone?
|
|
Check STYLE.md "Scope preservation".
|
|
|
|
### 6. Content Accuracy
|
|
- Factually incorrect information (wrong commands, wrong API endpoints)
|
|
- Broken links or references
|
|
- Contradictory content
|
|
- Mismatched information (e.g., code example shows X but text says Y)
|
|
- Security issues in example code
|
|
|
|
### 7. Front Matter & Hugo Syntax
|
|
- Missing required fields: `title`, `description`, `keywords`
|
|
- Incorrect shortcode syntax (check COMPONENTS.md)
|
|
- Invalid component usage
|
|
|
|
## Severity
|
|
- **high**: Will mislead users or break things (incorrect commands, wrong APIs, security issues, editing vendored files, missing redirects)
|
|
- **medium**: Could confuse users or violates style guide (AI-isms, scope inflation, unclear instructions, markdown formatting)
|
|
- **low**: Minor suggestions (rarely report)
|
|
|
|
Most issues should be MEDIUM. HIGH is for critical problems only.
|