Skip to content

docs(readme): direct users to release tags and document DA/CEA branch model - #291

Open
Harsheet jain (jainharsheet77) wants to merge 1 commit into
microsoft:mainfrom
jainharsheet77:harsheetjain/readme-releases-guidance
Open

Harsheet jain (jainharsheet77) wants to merge 1 commit into
microsoft:mainfrom
jainharsheet77:harsheetjain/readme-releases-guidance

Conversation

@jainharsheet77

@jainharsheet77 Harsheet jain (jainharsheet77) commented Sep 20, 2026

Copy link
Copy Markdown
Contributor

What & why

Following the new branch/release rulesets and Nkem's feedback, the README should point people to the release tags for each agent flavor instead of cloning a trunk branch (main) directly.

This updates the root README.md:

  • New "Which build to clone (releases, not main)" — clone the latest da-v* (Declarative Agent) or cea-v* (Custom Engine Agent) release tag; check the Releases page for the newest and substitute it.
  • "Get the code" walkthrough step — now clones a release tag, with a no-terminal Source code (zip) fallback, instead of the green < > CodeDownload ZIP button (which gives the in-development main).
  • New "Branches and releases" — documents the two-trunk model and where contributions go.

Branch model documented

Branch Trunk for Release line
main Declarative Agent (DA) da-v* (e.g. da-v1.0.0-rc.1)
main-ca Custom Engine Agent (CEA) cea-v* (e.g. cea-v1.0.0-rc.1)

Where contributions go: DA-only → main; CEA-only → main-ca; shared → both main and main-ca.

Both-trunk submission

This is a shared README change submitted to both trunks:

Direct consumers to clone the per-flavor release tag (da-v*/cea-v*) instead of a trunk branch, and add a 'Branches and releases' section explaining main (DA) vs main-ca (CEA) and where contributions go.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants