-
Notifications
You must be signed in to change notification settings - Fork 141
Document footer: false configuration, message customization, and XML marker search for safe outputs #15183
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.
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
Document footer: false configuration, message customization, and XML marker search for safe outputs #15183
Changes from all commits
24114be
fd96eeb
269d6dd
cd5057c
d1fd115
cb12aa1
df80db8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,152 @@ | ||||||
| --- | ||||||
| title: Footer Control | ||||||
| description: Learn how to control AI-generated footers in safe output operations and customize footer messages for GitHub issues, pull requests, discussions, and releases. | ||||||
| sidebar: | ||||||
| order: 805 | ||||||
| --- | ||||||
|
|
||||||
| Control whether AI-generated footers are added to created and updated GitHub items (issues, pull requests, discussions, releases). Footers provide attribution and links to workflow runs, but you may want to omit them for cleaner content or when using custom branding. | ||||||
|
|
||||||
| ## Global Footer Control | ||||||
|
|
||||||
| Set `footer: false` at the safe-outputs level to hide footers for all output types: | ||||||
|
|
||||||
| ```yaml wrap | ||||||
| safe-outputs: | ||||||
| footer: false # hide footers globally | ||||||
| create-issue: | ||||||
| title-prefix: "[ai] " | ||||||
| create-pull-request: | ||||||
| title-prefix: "[ai] " | ||||||
| ``` | ||||||
|
|
||||||
| When `footer: false` is set: | ||||||
| - **Visible footer content is omitted** - No AI-generated attribution text appears in the item body | ||||||
| - **XML markers are preserved** - Hidden workflow-id and tracker-id markers remain for searchability | ||||||
| - **All safe output types affected** - Applies to create-issue, create-pull-request, create-discussion, update-issue, update-discussion, and update-release | ||||||
|
|
||||||
| ## Per-Handler Footer Control | ||||||
|
|
||||||
| Override the global setting for specific output types by setting `footer` at the handler level: | ||||||
|
|
||||||
| ```yaml wrap | ||||||
| safe-outputs: | ||||||
| footer: false # global default: no footers | ||||||
| create-issue: | ||||||
| title-prefix: "[issue] " | ||||||
| # inherits footer: false | ||||||
| create-pull-request: | ||||||
| title-prefix: "[pr] " | ||||||
| footer: true # override: show footer for PRs only | ||||||
| ``` | ||||||
|
|
||||||
| Individual handler settings always take precedence over the global setting. | ||||||
|
|
||||||
| ## What's Preserved When Footer is Hidden | ||||||
|
|
||||||
| Even with `footer: false`, the following are still included: | ||||||
|
|
||||||
| 1. **Workflow-id marker** - Hidden HTML comment for search and tracking: | ||||||
| ```html | ||||||
| <!-- gh-aw-workflow-id: WORKFLOW_NAME --> | ||||||
|
||||||
| <!-- gh-aw-workflow-id: WORKFLOW_NAME --> | |
| <!-- gh-aw-workflow-id: WORKFLOW_ID --> |
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @copilot use less
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Removed Changes:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The bullet "All safe output types affected" is misleading here because
footeronly applies to specific create/update handlers (as listed), not every safe output type. Suggest rewording to something like "All footer-capable safe output types" or "Applies to: ..." without implying universal coverage.