Skip to content

Commit 6c7b72c

Browse files
docs(site): update sample-agent snippet to use modern repos: shorthand (#841)
Replace legacy repositories: format with the repos: shorthand in the examples.mdx sample-agent code block. New users copying the sample would previously get auto-rewritten output on first compile, which was confusing. Adding a tip callout linking to the repos: reference. Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 47afcf7 commit 6c7b72c

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

site/src/content/docs/guides/examples.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ A minimal example demonstrating the basic structure of an agent file.
1515

1616
**Key features:**
1717
- Simple daily schedule trigger
18-
- Repository checkout configuration
18+
- Repository checkout using the `repos:` shorthand
1919
- Basic workspace setup
2020
- Straightforward agent prompt
2121

@@ -27,10 +27,8 @@ name: "Daily Code Review"
2727
description: "Reviews code changes and creates summary reports"
2828
on:
2929
schedule: daily
30-
repositories:
31-
- repository: azure-devops-agentic-pipelines
32-
type: git
33-
name: azure-devops-agentic-pipelines
30+
repos:
31+
- my-org/my-repo
3432
workspace: repo
3533
---
3634

@@ -45,6 +43,10 @@ Review the latest code changes in the repository and provide feedback.
4543
3. Generate a summary report
4644
```
4745

46+
:::tip[repos: shorthand]
47+
`repos:` is the current recommended syntax for repository checkout. The legacy `repositories:` format is automatically rewritten to `repos:` on the next `ado-aw compile`. See [Repositories (repos:)](/ado-aw/reference/front-matter/#repositories-repos) for the full syntax.
48+
:::
49+
4850
## ADO work item triage
4951

5052
**[`examples/azure-devops-mcp.md`](https://github.com/githubnext/ado-aw/blob/main/examples/azure-devops-mcp.md)**

0 commit comments

Comments
 (0)