11# Releasing Packages
22
3- This repository uses [ Changesets] ( https://github.com/changesets/changesets ) to manage versioning and publishing of packages. This guide explains how to create releases for SDK and tools packages.
3+ This repository uses [ Changesets] ( https://github.com/changesets/changesets ) to manage versioning and publishing of packages. This guide explains how to create releases for builder and tools packages.
44
55## Package Versioning Strategy
66
7- - ** SDK ** (` @plotday/agent ` ): Independent versioning
7+ - ** Agent Builder ** (` @plotday/agent ` ): Independent versioning
88- ** Tools** (` @plotday/tool-* ` ): Independent versioning
99- ** Agents** (` @plotday/agent-* ` ): Not published, excluded from releases
1010
1111Each package maintains its own version and can be released independently.
1212
1313## How to Add a Changeset
1414
15- When you make changes to the SDK or any tools package, you need to add a changeset before merging your PR.
15+ When you make changes to the builder or any tools package, you need to add a changeset before merging your PR.
1616
1717### 1. Create a Changeset
1818
@@ -25,7 +25,7 @@ This will prompt you with:
25251 . ** Which packages would you like to include?**
2626
2727 - Select the packages you've modified (use space to select, enter to confirm)
28- - Only SDK and tools packages can be selected (agents are excluded)
28+ - Only builder and tools packages can be selected (agents are excluded)
2929
30302 . ** What kind of change is this?**
3131
@@ -53,14 +53,14 @@ The changeset file will be created in `.changeset/` with a random name like `.ch
5353
54541 . ** Developer makes changes**
5555
56- - Make your changes to SDK or tools packages
56+ - Make your changes to builder or tools packages
5757 - Run ` pnpm changeset ` to add a changeset
5858 - Commit the changeset file along with your changes
5959 - Open a PR to ` main `
6060
61612 . ** PR validation**
6262
63- - GitHub Actions will check if SDK /tools were modified
63+ - GitHub Actions will check if builder /tools were modified
6464 - If modified, it ensures a changeset file exists
6565 - PR cannot be merged without a changeset (or admin override)
6666
@@ -79,7 +79,7 @@ The changeset file will be created in `.changeset/` with a random name like `.ch
7979 - Builds all packages
8080 - Publishes changed packages to npm
8181 - Creates GitHub releases with changelogs
82- - Tags each release (e.g., ` sdk @0.9.1` , ` tool-google-calendar@0.1.0 ` )
82+ - Tags each release (e.g., ` agent @0.9.1` , ` tool-google-calendar@0.1.0 ` )
8383
8484## GitHub Releases
8585
@@ -89,7 +89,7 @@ When packages are published, GitHub releases are automatically created with the
8989
9090Each package gets its own tag based on its directory structure:
9191
92- - ** SDK ** : ` sdk @0.9.1`
92+ - ** Agent Builder ** : ` agent @0.9.1`
9393- ** Tools** : ` tool-google-calendar@0.1.0 ` , ` tool-outlook-calendar@0.1.0 ` , etc.
9494
9595This tagging convention allows you to:
@@ -112,16 +112,16 @@ View all releases at: `https://github.com/plotday/plot/releases`
112112
113113Or filter by package:
114114
115- - SDK releases: Search for tags starting with ` sdk @`
115+ - Builder releases: Search for tags starting with ` agent @`
116116- Tool releases: Search for tags starting with ` tool- `
117117
118118### Manual GitHub Release
119119
120120If you need to create a GitHub release manually after publishing:
121121
122122``` bash
123- # For SDK
124- gh release create sdk @0.9.1 --title " @plotday/agent@0.9.1" --notes " Release notes here"
123+ # For Agent Builder
124+ gh release create agent @0.9.1 --title " @plotday/agent@0.9.1" --notes " Release notes here"
125125
126126# For a tool
127127gh release create tool-google-calendar@0.1.0 --title " @plotday/tool-google-calendar@0.1.0" --notes " Release notes here"
@@ -198,7 +198,7 @@ git push
198198pnpm release
199199
200200# 5. (Optional) Create GitHub release manually
201- gh release create sdk @0.9.1 --title " @plotday/agent@0.9.1" --notes " Release notes"
201+ gh release create agent @0.9.1 --title " @plotday/agent@0.9.1" --notes " Release notes"
202202```
203203
204204⚠️ This should only be done in emergencies. The automated workflow is preferred.
@@ -240,4 +240,4 @@ gh release create sdk@0.9.1 --title "@plotday/agent@0.9.1" --notes "Release note
240240
241241- [ Changesets documentation] ( https://github.com/changesets/changesets )
242242- [ Semantic Versioning (semver)] ( https://semver.org/ )
243- - [ Plot SDK repository] ( https://github.com/plotday/plot )
243+ - [ Plot repository] ( https://github.com/plotday/plot )
0 commit comments