Skip to content

Commit f442005

Browse files
theletterfGPT-5.5cursoragent
authored
Avoid redacted crosslinks in docs review suggestions (#191)
* Avoid redacted crosslinks in docs review suggestions Configure the docs review workflow sanitizer for expected docs hosts and steer review suggestions away from apply-ready patches that include link targets safe outputs may rewrite. Co-authored-by: GPT-5.5 <gpt-5.5@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com> * Preserve existing gh-aw action pins Keep the previous v0.79.3 action cache entries while adding the v0.79.6 setup pin needed by the regenerated docs review workflow. Co-authored-by: GPT-5.5 <gpt-5.5@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com> * Narrow crosslink suggestion guidance Allow relative links in docs review suggestions while avoiding custom-protocol links and bare URLs outside the safe-output allowlist. Co-authored-by: GPT-5.5 <gpt-5.5@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: GPT-5.5 <gpt-5.5@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent b7b1810 commit f442005

2 files changed

Lines changed: 19 additions & 11 deletions

File tree

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

Lines changed: 13 additions & 11 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: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ network:
7070
- "docs-v3-preview.elastic.dev"
7171
strict: false
7272
safe-outputs:
73+
allowed-domains:
74+
- www.elastic.co
75+
- docs-v3-preview.elastic.dev
76+
- github.com
7377
noop:
7478
add-comment:
7579
max: 1
@@ -453,6 +457,8 @@ For inline comments with concrete replacements:
453457
- keep the suggested replacement as small as possible while still fixing the issue, and
454458
- inspect the exact comment body before calling `create_pull_request_review_comment`, especially when using a suggestion block, to confirm it contains the literal replacement text you want GitHub to apply.
455459

460+
Do not use a GitHub suggestion block when the replacement contains a custom-protocol link target such as `kibana://` or `docs-content://`. Also avoid suggestion blocks for bare URLs that are not covered by the safe-output allowlist. Relative links are OK in suggestion blocks. For unsafe link targets, explain the replacement in prose or quote only the affected link target in inline code.
461+
456462
Treat low-priority nits differently:
457463

458464
- avoid nits unless they are grounded in the pre-fetched Vale output or another explicit review rule in this workflow,

0 commit comments

Comments
 (0)