Skip to content

Commit fa00c21

Browse files
authored
Update report.md: recommend safe-outputs filtering for mentions and backlinks (#18623)
1 parent 8d6d854 commit fa00c21

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

.github/aw/report.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,3 +107,27 @@ Reports should:
107107
- Format run IDs as links: `[§12345](https://github.com/owner/repo/actions/runs/12345)`
108108
- Include up to 3 most relevant run URLs at the end under `**References:**`
109109
- Do NOT add footer attribution — the system appends it automatically
110+
111+
## Avoiding Mentions and Backlinks
112+
113+
Reports often reference issues, PRs, or users. Without filtering, `@username` sends a notification and `#123` creates a cross-reference backlink on that issue or PR — adding noise every time the report runs.
114+
115+
Use the built-in safe-outputs filtering options to suppress this automatically:
116+
117+
- **`mentions: false`** — escapes all `@mentions` in AI-generated output so no notifications are sent.
118+
- **`allowed-github-references: []`** — escapes all `#123` / `owner/repo#123` references so no backlinks are created on referenced items.
119+
- **`max-bot-mentions: 0`** — neutralizes bot-trigger phrases such as `fixes #123` or `closes #456` that would otherwise close referenced issues.
120+
121+
```yaml
122+
safe-outputs:
123+
mentions: false
124+
allowed-github-references: []
125+
max-bot-mentions: 0
126+
create-issue:
127+
title-prefix: "Weekly Status:"
128+
labels: [report]
129+
close-older-issues: true
130+
expires: 30
131+
```
132+
133+
These options apply globally to all safe-output types (issues, comments, discussions) and are the recommended way to keep reports from polluting unrelated items.

0 commit comments

Comments
 (0)