Skip to content

Avoid redacted crosslinks in docs review suggestions #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
theletterf merged 4 commits into from
Jun 17, 2026
+19 −11
Merged

Avoid redacted crosslinks in docs review suggestions #191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
764c73f
Avoid redacted crosslinks in docs review suggestions
theletterf Jun 17, 2026
ff1c9b1
Preserve existing gh-aw action pins
theletterf Jun 17, 2026
a912e0a
Merge remote-tracking branch 'origin/main' into fab/docs-review-cross…
theletterf Jun 17, 2026
74523aa
Narrow crosslink suggestion guidance
theletterf Jun 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions .github/workflows/gh-aw-docs-review.lock.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .github/workflows/gh-aw-docs-review.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ network:
- "docs-v3-preview.elastic.dev"
strict: false
safe-outputs:
allowed-domains:
- www.elastic.co
- docs-v3-preview.elastic.dev
- github.com
noop:
add-comment:
max: 1
Expand Down Expand Up @@ -453,6 +457,8 @@ For inline comments with concrete replacements:
- keep the suggested replacement as small as possible while still fixing the issue, and
- 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.

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.

Treat low-priority nits differently:

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