Document footer: false configuration, message customization, and XML marker search for safe outputs #15183
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
@copilot also document customizing messages in that section |
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Added "Customizing Footer Messages" subsection in the Footer Control section (269d6dd). The new subsection documents:
Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
|
@copilot move all footer content into a "footers.md" and refernce it from safe-outputs reference page. |
|
@copilot document how to use the xml markers to search for generated items |
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Moved footer content into separate Changes:
Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Added comprehensive XML marker search documentation (d1fd115). New "Searching for Workflow-Created Items" subsection includes:
Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
There was a problem hiding this comment.
@copilot use less footer: false entries in examples. Only add to footer section
There was a problem hiding this comment.
Removed footer: false from all configuration examples in safe-outputs.md (cb12aa1).
Changes:
- Removed footer field from 7 handler examples (create-issue, create-pull-request, create-discussion, update-issue, update-pull-request, update-discussion, update-release)
- Removed 3 related NOTE callouts about footer field behavior
- Kept single TIP reference in create-issue section linking to footers.md
- All footer examples and documentation now consolidated in the dedicated footers.md page
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
There was a problem hiding this comment.
Pull request overview
This PR restructures and expands documentation for safe output footers by moving detailed guidance into a dedicated reference page and leaving a concise pointer in the main Safe Outputs reference.
Changes:
- Added a new dedicated reference page for footer behavior/configuration (
footer: false), footer message customization, and searching via XML markers. - Updated
safe-outputs.mdto include a brief TIP + a short “Footer Control” reference section linking to the new page. - Consolidated XML marker search guidance into the new page with multiple GitHub search examples.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/src/content/docs/reference/safe-outputs.md | Adds a TIP and a concise “Footer Control” section that links to the new dedicated footer documentation. |
| docs/src/content/docs/reference/footers.md | Introduces the new dedicated Footer Control reference page with configuration, preserved markers, and search examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 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 |
There was a problem hiding this comment.
The bullet "All safe output types affected" is misleading here because footer only 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.
| - **All safe output types affected** - Applies to create-issue, create-pull-request, create-discussion, update-issue, update-discussion, and update-release | |
| - **Applies to footer-capable handlers** - create-issue, create-pull-request, create-discussion, update-issue, update-discussion, and update-release |
|
|
||
| 1. **Workflow-id marker** - Hidden HTML comment for search and tracking: | ||
| ```html | ||
| <!-- gh-aw-workflow-id: WORKFLOW_NAME --> |
There was a problem hiding this comment.
In the workflow-id marker example, the placeholder says WORKFLOW_NAME, but the value is the workflow ID (derived from the workflow Markdown filename without the .md extension via GH_AW_WORKFLOW_ID). Using WORKFLOW_ID (or clarifying in the example) would avoid confusion with the human-readable workflow name.
| <!-- gh-aw-workflow-id: WORKFLOW_NAME --> | |
| <!-- gh-aw-workflow-id: WORKFLOW_ID --> |
Document footer: false in safe outputs ✅
Plan
Summary
Successfully documented the
footer: falsefeature in the safe-outputs reference documentation. This feature allows workflows to control whether AI-generated footers are added to created and updated GitHub items.Documentation Structure
New File:
docs/src/content/docs/reference/footers.mdfooter: falsemessages.footertemplatefooter: falsevsmessages.footerUpdated:
docs/src/content/docs/reference/safe-outputs.mdfooter: falsefrom configuration examplesKey Features Documented
safe-outputs.footer: falsehides footers for all outputstrue(show footer) for existing workflowsmessages.footertemplate to customize footer text instead of hidingXML Marker Search Examples Documented
The footers.md page includes comprehensive examples of searching for workflow-created items:
Documentation Organization
footer: falseusage now in the dedicated footer control pageBuild Validation
✅ Documentation built successfully with no errors
✅ All internal links validated
✅ New footers.md page generated (115 total pages)
✅ Improved documentation organization with cleaner examples
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.