Skip to content

Commit b0f265c

Browse files
committed
chore: document release process
1 parent 809e506 commit b0f265c

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,3 +184,41 @@ Pending feedback, we're considering the following features:
184184
In the short term, AgentAPI solves the problem of how to programmatically control coding agents. As time passes, we hope to see the major agents release proper SDKs. One might wonder whether AgentAPI will still be needed then. We think that depends on whether agent vendors decide to standardize on a common API, or each sticks with a proprietary format.
185185

186186
In the former case, we'll deprecate AgentAPI in favor of the official SDKs. In the latter case, our goal will be to make AgentAPI a universal adapter to control any coding agent, so a developer using AgentAPI can switch between agents without changing their code.
187+
188+
## For Maintainers
189+
190+
### Release Process
191+
192+
Before performing a release, perform a local "smoke-test".
193+
If everything seems OK, you can proceed to do the following:
194+
195+
1. Update the version string in the following places:
196+
- `openapi.json`
197+
- `chat/package.json`
198+
- `lib/httpapi/server.go`
199+
2. Add details in `CHANGELOG.md` on what changed.
200+
3. Create a PR with the subject `chore: update version to X.Y.Z`
201+
4. Once the above PR is approved and merged, create a new git tag `vX.Y.Z` pointing to the commit of the above PR merged to `main`:S
202+
203+
```shell
204+
# Fetch existing tags first!
205+
git fetch --tags
206+
git tag -a vX.Y.Z -m 'vX.Y.Z'
207+
```
208+
209+
5. Push the tag:
210+
211+
```shell
212+
git push origin tag vX.Y.Z
213+
```
214+
215+
6. Visit `https://github.com/coder/agentapi/releases/tag/vX.Y.Z` and "Create release from tag".
216+
217+
- Select the tag you pushed previously.
218+
- Select the previous tag and "Generate release notes". Amend as required.
219+
- **IMPORTANT:** un-check "Set as latest release" and check "Set as a pre-release".
220+
- Click "Publish Release". This will trigger a "Build Release Binaries" CI job.
221+
222+
7. Visit `https://github.com/coder/agentapi/actions/workflows/release.yml` and monitor the status of the job that was created in the previous step. This will upload the built assets to the corresponding release.
223+
224+
8. Once the updated assets are released, you can now visit `https://github.com/coder/agentapi/releases/tag/vX.Y.Z`, click "Edit" (✎), and check "Set as latest release".

0 commit comments

Comments
 (0)