docs: changelog, lessons learned + re-add labels config#199
Merged
Conversation
The labels: [aw] config was removed based on a vague 'node ID resolution error' that was never properly investigated. The gh-aw docs officially support this field. Re-adding it so labels are applied by infrastructure, not dependent on agent behavior. Closes #108 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates repo-level documentation (changelog + lessons learned) and restores infrastructure-managed aw labeling for implementer-created PRs via the gh-aw labels config.
Changes:
- Re-add
labels: [aw]to thecreate-pull-requestsafe-output in the issue implementer workflow (and recompile the lock file). - Add new “Common Pitfalls” entries and update agent inventory/history in
docs/agentic-workflows.md. - Add multiple new changelog entries describing recent workflow/infrastructure learnings and fixes.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/changelog.md | Adds new changelog entries covering labels config, responder pre-fetch pattern, dispatch dedup, and quality gate label desync. |
| docs/agentic-workflows.md | Expands pitfalls list, updates agent inventory table, and appends history notes for recent incidents/fixes. |
| .github/workflows/issue-implementer.md | Restores labels: [aw] in safe-outputs.create-pull-request. |
| .github/workflows/issue-implementer.lock.yml | Regenerated lock file reflecting the labels config and updated compiled metadata. |
Comments suppressed due to low confidence (1)
docs/agentic-workflows.md:509
- The "Common Pitfalls" section now flows directly into debugging commands (e.g., "Check if a workflow compiled correctly") without a "Debugging" header or a separate
<details>block, which makes the section structure confusing (debugging content is effectively nested under pitfalls). Consider reintroducing a dedicated Debugging section (e.g.,<details><summary>Debugging</summary> ... </details>) or at least add a clear heading break before the debugging commands.
### 27. Shared imports use `imports:` + `steps:` pattern
To pre-fetch data before the agent runs, create a shared `.md` file with a `steps:` block in the frontmatter. The importing workflow uses `imports: [shared/filename.md]`. The steps run as regular workflow steps (with full `gh` CLI access and `GITHUB_TOKEN`), writing data to `/tmp/gh-aw/` for the agent to read. This bypasses MCP tool limitations. Based on the pattern from `github/gh-aw`'s own `copilot-pr-data-fetch.md`.
### Check if a workflow compiled correctly
```bash
grep 'GH_AW_ALLOWED_BOTS\|GH_AW_REQUIRED_ROLES\|pre_activation' .github/workflows/your-workflow.lock.yml
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
2e5bb5d to
0882f85
Compare
0882f85 to
17ea95a
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…d label desync - Changelog: entries for PR #186 (pre-fetch), PR #190 (dedup fix), quality gate label/approval desync - Agentic-workflows: 5 new pitfalls (#23-27), updated agent inventory table, history entry for 2026-03-20/21 session Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
17ea95a to
b15b075
Compare
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.
Changes
1. Re-add
labels: [aw]to implementer configlabelsis officially supported (REST API, not node IDs)2. Documentation updates
tools:block in shared imports restricts entire agentgh run list --statusonly accepts single valuecancel-in-progress: truedangerous with side effectsimports:+steps:pattern