Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 1.46 KB

File metadata and controls

28 lines (19 loc) · 1.46 KB

Information for Maintainers

Release Process

Before performing a release, perform a local "smoke-test":

  • For most changes, simply running go test ./e2e may be sufficient.
  • For agent-specific changes, manual testing may be required.

If everything seems OK, you can proceed to do the following:

  1. Update the version string in internal/version/version.go and run make gen.

  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, update your local branch and run release.sh. If the script reports errors, fix them before continuing. If there are no issues, it will output the Github tag URL.

  5. 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.
  6. 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.

  7. 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".