Thanks to visit codestin.com
Credit goes to github.com

Skip to content
Merged
Changes from all commits
Commits
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
37 changes: 37 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Information for Maintainers

## Release Process

Before performing a release, perform a local "smoke-test".
If everything seems OK, you can proceed to do the following:

1. Update the version string in the following places:
- `openapi.json`
- `chat/package.json`
- `lib/httpapi/server.go`
2. Add details in `CHANGELOG.md` on what changed.
3. Create a PR with the subject `chore: update version to X.Y.Z`
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

```shell
# Fetch existing tags first!
git fetch --tags
git tag -a vX.Y.Z -m 'vX.Y.Z'
```

5. Push the tag:

```shell
git push origin tag vX.Y.Z
```

6. Visit `https://github.com/coder/agentapi/releases/tag/vX.Y.Z` and "Create release from tag".

- Select the tag you pushed previously.
- Select the previous tag and "Generate release notes". Amend as required.
- **IMPORTANT:** un-check "Set as latest release" and check "Set as a pre-release".
- Click "Publish Release". This will trigger a "Build Release Binaries" CI job.

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.

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".
Comment on lines +3 to +37
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks quite involved around marking release as not latest and then marking it as latest.

Not now, but we should script it out to automate the whole workflow when a tag is pushed.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed 100%, some scripts are definitely warranted here