Skip to content

Commit 2b21031

Browse files
theletterfGPT-5.4
andcommitted
Make docs-review advisory-only.
Limit docs-review to non-blocking comment reviews, remove low-signal review-summary boilerplate, and document the current Vale dependency behavior in the workflow README. Co-authored-by: GPT-5.4 <gpt-5.4@openai.com> Made-with: Cursor
1 parent bb01471 commit 2b21031

3 files changed

Lines changed: 19 additions & 27 deletions

File tree

.github/workflows/gh-aw-docs-review.lock.yml

Lines changed: 14 additions & 19 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.github/workflows/gh-aw-docs-review.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ safe-outputs:
8080
submit-pull-request-review:
8181
max: 1
8282
target: "triggering"
83-
allowed-events: [COMMENT, REQUEST_CHANGES]
83+
allowed-events: [COMMENT]
8484
timeout-minutes: 30
8585
steps:
8686
- name: Repo-specific setup
@@ -253,7 +253,7 @@ If you found one or more high-confidence actionable issues:
253253
- create up to 20 focused inline review comments, and
254254
- submit one consolidated pull request review.
255255

256-
Use `REQUEST_CHANGES` only when the issues are important enough that the PR should be revised before merge. Otherwise use `COMMENT`.
256+
Always use `COMMENT` for the final review. This workflow is advisory and must not block merging through a `REQUEST_CHANGES` review state.
257257

258258
## Review body format
259259

@@ -262,11 +262,6 @@ Submit one final review body in this shape:
262262
```markdown
263263
## Docs review summary
264264

265-
- Reviewed `<N>` changed markdown file(s) in scope.
266-
- Reviewed scope: `<docs-subtree | repo-wide-markdown>`.
267-
- Ignored `<N>` non-eligible changed file(s) outside the review scope.
268-
- Outcome: `<No actionable issues | Commented suggestions | Changes requested>`.
269-
270265
### Focus areas
271266
- Style and clarity: <short result>.
272267
- Jargon: <short result>.

agentic-workflows/docs-review/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Configure the `COPILOT_GITHUB_TOKEN` secret before running the workflow.
3434
|--------|-----|-------------|
3535
| `noop` || Used when the trigger is not a pull request, or the PR has no changed `docs/**/*.md` files |
3636
| `create-pull-request-review-comment` | 20 | Adds focused inline review comments on changed markdown lines |
37-
| `submit-pull-request-review` | 1 | Submits the overall pull request review summary as `COMMENT` or `REQUEST_CHANGES` |
37+
| `submit-pull-request-review` | 1 | Submits the overall pull request review summary as a non-blocking `COMMENT` |
3838

3939
The inline review comment cap for this workflow is set to `20`, so the workflow prioritizes the highest-signal comments and keeps broader observations in the summary review. Lower-priority nits should only be reported when they are grounded in the Elastic style guide, and those nits should usually be summarized in the review body instead of consuming inline comment slots.
4040

@@ -68,6 +68,8 @@ The review prompt instructs the Copilot agent to invoke these imported skills by
6868

6969
When an inline comment can be expressed as a small, exact replacement for the reviewed line or hunk, the workflow should prefer an apply-ready GitHub suggestion block over prose-only guidance.
7070

71+
Only `docs-check-style` explicitly references Vale. That skill tries the `vale_lint` MCP tool first and otherwise falls back to the `vale` CLI when available. The reusable workflow itself does not install Vale, so if the runtime environment lacks a `vale` binary and no Vale MCP tool is present, that skill falls back to manual style review.
72+
7173
## Example
7274

7375
```yaml

0 commit comments

Comments
 (0)