Move auto-generated notice to first line with debugging skill URL#38923
Merged
Conversation
The header comment now starts with the auto-generated disclaimer on line 1, extended with an instruction to load the debugging-workflows skill at github.ghaw.github.gill.agenticworkflow. The ASCII logo follows after. Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
pelikhan
June 12, 2026 20:07
View session
Collaborator
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Contributor
Author
Updated the URL to |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adjusts gh-aw’s generated workflow header to surface the auto-generated disclaimer earlier (before the ASCII logo) and appends a debugging pointer, then recompiles generated workflow files to reflect the new header layout.
Changes:
- Reordered
GenerateWorkflowHeaderoutput so the disclaimer is emitted before the ASCII logo. - Added a debugging pointer to the disclaimer line and extended tests to assert first-line placement / URL presence.
- Recompiled a large set of generated workflow outputs (
.lock.ymland generated workflow YAMLs) to apply the new header.
Show a summary per file
| File | Description |
|---|---|
| pkg/workflow/header.go | Moves the disclaimer ahead of the logo and appends a debugging pointer to the disclaimer line. |
| pkg/workflow/header_test.go | Adds assertions that the disclaimer is on the first header line and includes the debugging URL. |
| .github/workflows/*.lock.yml (246 files) | Recompiled generated lock workflows to include the updated header ordering + pointer line. |
| .github/workflows/agentics-maintenance.yml | Regenerated workflow with the updated header ordering + pointer line. |
| .github/workflows/agentic_commands.yml | Updates the embedded generated header block to match the new disclaimer + pointer line. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 250/250 changed files
- Comments generated: 3
Comment on lines
52
to
53
| header.WriteString("#\n") | ||
|
|
||
| // Add auto-generated disclaimer | ||
| // Include version for released builds only (not "dev") | ||
| if generatedBy != "" { | ||
| if IsReleasedVersion(GetVersion()) { | ||
| fmt.Fprintf(&header, "# This file was automatically generated by %s (%s). DO NOT EDIT.\n", generatedBy, GetVersion()) | ||
| } else { | ||
| fmt.Fprintf(&header, "# This file was automatically generated by %s. DO NOT EDIT.\n", generatedBy) | ||
| } | ||
| } else { | ||
| header.WriteString("# This file was automatically generated. DO NOT EDIT.\n") | ||
| } | ||
| header.WriteString("#\n") |
Comment on lines
1
to
+4
| # gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"e35c716905c374c7dc3abc08403adc8737cbfc3b8a4f938cbc19f8f842eec8ff","body_hash":"a647ff4032d676c31da8936bbb5ef36c734cdeab0cab008756ca1ef7560ae99c","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.60"}} | ||
| # gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GH_AW_OTEL_GRAFANA_AUTHORIZATION","GH_AW_OTEL_GRAFANA_ENDPOINT","GH_AW_OTEL_SENTRY_AUTHORIZATION","GH_AW_OTEL_SENTRY_ENDPOINT","GITHUB_TOKEN"],"actions":[{"repo":"actions/checkout","sha":"df4cb1c069e1874edd31b4311f1884172cec0e10","version":"v6.0.3"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2","digest":"sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2@sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2","digest":"sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2@sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2","digest":"sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2@sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.25","digest":"sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.25@sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa"},{"image":"ghcr.io/github/github-mcp-server:v1.1.2","digest":"sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c","pinned_image":"ghcr.io/github/github-mcp-server:v1.1.2@sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c"}]} | ||
| # This file was automatically generated by gh-aw. DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md | ||
| # |
Comment on lines
+30
to
+42
| // Add auto-generated disclaimer as the very first line. | ||
| // This ensures agents see the notice immediately and can load the debugging skill. | ||
| // Include version for released builds only (not "dev") | ||
| const skillPointer = " To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md" | ||
| if generatedBy != "" { | ||
| if IsReleasedVersion(GetVersion()) { | ||
| fmt.Fprintf(&header, "# This file was automatically generated by %s (%s). DO NOT EDIT.%s\n", generatedBy, GetVersion(), skillPointer) | ||
| } else { | ||
| fmt.Fprintf(&header, "# This file was automatically generated by %s. DO NOT EDIT.%s\n", generatedBy, skillPointer) | ||
| } | ||
| } else { | ||
| fmt.Fprintf(&header, "# This file was automatically generated. DO NOT EDIT.%s\n", skillPointer) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Compiler header now emits the auto-generated disclaimer as line 1 (before the ASCII logo) and appends a skill pointer so agents debugging workflow runs can immediately load context.
pkg/workflow/header.go— Reorder header: disclaimer first, logo second. Append skill URL to the disclaimer line.pkg/workflow/header_test.go— Assert first-line placement and URL presence..lock.ymlfiles — Recompiled with new header.Generated first line:
# This file was automatically generated by gh-aw. DO NOT EDIT. To debug this workflow, load the skill at github.ghaw.github.gill.agenticworkflow