-
Notifications
You must be signed in to change notification settings - Fork 73
chore: document release process #65
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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". | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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