Skip to content

[docs] Add branch-prefix documentation for repo-memory (Jan 7, 2026) #9266

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 1 commit into from
Jan 7, 2026
Merged

[docs] Add branch-prefix documentation for repo-memory (Jan 7, 2026) #9266

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 6 additions & 3 deletions docs/src/content/docs/reference/memory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ Creates branch `memory/default` at `/tmp/gh-aw/repo-memory-default/`. Files are
tools:
repo-memory:
branch-name: memory/custom-agent
branch-prefix: campaigns # Custom prefix instead of "memory"
description: "Long-term insights"
file-glob: ["memory/custom-agent/*.md", "memory/custom-agent/*.json"]
max-file-size: 1048576 # 1MB (default 10KB)
Expand All @@ -120,6 +121,8 @@ tools:
---
```

**Branch Prefix**: Use `branch-prefix` to customize the branch name prefix (default is `memory`). The prefix must be 4-32 characters, alphanumeric with hyphens/underscores, and cannot be `copilot`. When set, branches are created as `{branch-prefix}/{id}` instead of `memory/{id}`.

**Note**: File glob patterns must include the full branch path structure. For branch `memory/custom-agent`, use patterns like `memory/custom-agent/*.json` to match files stored at that path within the branch.

## Multiple Repo Memory Configurations
Expand All @@ -129,15 +132,15 @@ tools:
tools:
repo-memory:
- id: insights
branch-name: memory/insights
file-glob: ["memory/insights/*.md"]
branch-prefix: daily # Creates daily/insights branch
file-glob: ["daily/insights/*.md"]
- id: state
file-glob: ["memory/state/*.json"]
max-file-size: 524288 # 512KB
---
```

Mounts at `/tmp/gh-aw/repo-memory-{id}/` during workflow execution. Required `id` determines folder name; `branch-name` defaults to `memory/{id}`. Files are stored within the git branch at the branch name path (e.g., for branch `memory/code-metrics`, files are stored at `memory/code-metrics/` within the branch). **File glob patterns must include the full branch path.**
Mounts at `/tmp/gh-aw/repo-memory-{id}/` during workflow execution. Required `id` determines folder name; `branch-name` defaults to `{branch-prefix}/{id}` (where `branch-prefix` defaults to `memory`). Files are stored within the git branch at the branch name path (e.g., for branch `memory/code-metrics`, files are stored at `memory/code-metrics/` within the branch). **File glob patterns must include the full branch path.**

## Behavior

Expand Down