Skip to content

Deep-clean .github/aw/*.md: remove invalid patterns and deprecated references #22313

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.

Sign up for GitHub

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

Merged
pelikhan merged 3 commits into from
Mar 22, 2026
Merged

Deep-clean .github/aw/*.md: remove invalid patterns and deprecated references #22313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34e5232
Initial plan
Copilot Mar 22, 2026
d08e50c
docs: clean up deprecated and invalid content in .github/aw/ prompt f…
Copilot Mar 22, 2026
549ac43
Fix write permissions in test-coverage.md frontmatter template
Copilot Mar 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/aw/create-agentic-workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,7 +603,6 @@ on:
label_command: deploy
permissions:
contents: read
pull-requests: write # Required for automatic label removal
safe-outputs:
add-comment:
max: 1
Expand Down
110 changes: 3 additions & 107 deletions .github/aw/github-agentic-workflows.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 7 additions & 7 deletions .github/aw/memory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,15 +156,15 @@ tools:
allowed-extensions: [".json", ".md"]
max-file-size: 10240 # bytes
max-file-count: 100
permissions:
contents: write # Required: repo-memory writes to the repo
```
The compiler automatically creates a separate `push_repo_memory` job with `contents: write` permission. The main agent job retains read-only permissions.

### Tradeoffs

| ✅ Pros | ❌ Cons |
|---|---|
| Persists indefinitely (no expiry) | Requires `contents: write` permission |
| Persists indefinitely (no expiry) | Produces Git commits — repository noise |
| Auditable: Git history shows every change | Produces Git commits — repository noise |
Copy link

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The repo-memory tradeoffs table now repeats the same con (“Produces Git commits — repository noise”) for two different pros, which makes the comparison less informative. Consider replacing one of these with a distinct downside (e.g., requires a push job / write permission handled via compiler, potential merge conflicts, etc.) or consolidating the row to avoid duplication.

This issue also appears on line 202 of the same file.

Suggested change
| Auditable: Git history shows every change | Produces Git commits — repository noise |
| Auditable: Git history shows every change | Requires separate push job with write permissions |

Copilot uses AI. Check for mistakes.
| Survives cache invalidation | Slower: requires Git clone + push |
| Human-readable via GitHub branch UI | Not available for Copilot engine (requires GitHub tools) |
Expand All @@ -189,17 +189,17 @@ tools:
repo-memory:
wiki: true
allowed-extensions: [".md"]
permissions:
contents: write # Required: wiki writes via push
```

The compiler automatically creates a separate `push_repo_memory` job with `contents: write` permission. The main agent job retains read-only permissions.

Files follow GitHub Wiki Markdown conventions: use `[[Page Name]]` syntax for internal links, name files with hyphens instead of spaces.

### Tradeoffs

| ✅ Pros | ❌ Cons |
|---|---|
| Browsable in the GitHub Wiki UI | Requires `contents: write` permission |
| Browsable in the GitHub Wiki UI | Produces Git commits to wiki repo |
| Great for human-readable knowledge bases | Produces Git commits to wiki repo |
| Standard Markdown with wiki link syntax | Restricted to `.md` files in practice |
| Separate from main repo history | Less suitable for structured JSON state |
Expand All @@ -213,7 +213,7 @@ Files follow GitHub Wiki Markdown conventions: use `[[Page Name]]` syntax for in
| **First choice** | ✅ Yes | No | No |
| **Storage backend** | GitHub Actions cache | Git branch | GitHub Wiki |
| **Persistence** | Up to 90 days | Indefinite | Indefinite |
| **Requires `contents: write`** | No | Yes | Yes |
| **Compiler adds `contents: write`** | No | Yes (push job) | Yes (push job) |
| **Repository noise** | None | Git commits | Wiki commits |
| **Human-readable in GitHub** | No | Via branch UI | Via Wiki UI |
| **Structured data (JSON)** | ✅ Ideal | Possible | Not recommended |
Expand Down
1 change: 0 additions & 1 deletion .github/aw/test-coverage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ on:
pull_request:
types: [opened, synchronize]
permissions:
pull-requests: write # post coverage comment
actions: read # download artifacts
network: defaults
tools:
Expand Down
Loading