Repository navigation
chore: onboard the code review bot - #110
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #110 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 69 69
Lines 2187 2187
Branches 272 272
=========================================
Hits 2187 2187 Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This repository has carried
.github/code-review/REVIEW.mdsince the SDK rules landed, but nothing read it: there was no caller workflow and no policy. This is the rest of the onboarding. It is the last of the six SDKs.What this adds
.github/workflows/code-review.yml— the caller, copied from sdk-js's, which is the shape four of the five onboarded repos run.Dispatch only for now, deliberately. The automatic
workflow_runtrigger is written out and commented. sdk-py is the only repo with it armed; sdk-php, sdk-go, sdk-java and sdk-js all hold it back so a person reads the first review before every open pull request gets one. This repository has never been reviewed by the bot, so the same caution applies. Arming it later is deleting two comment markers and the banner..github/code-review/policy.yml— Codex first with Claude as fallback, matching the other five.gate: trueandrequire_ci_green: true.ignore_pathsadds**/bin/**and**/obj/**on top of the shared list, so a restored or published tree cannot spend the diff budget ahead of the source beside it.I validated it through the bot's own loader rather than by eye:
One change beyond the onboarding, and why
.github/workflows/ci.yml:name: CIbecomesname: Tests.The bot's trigger names a workflow by its
name:, never its filename. Every other SDK names its pull-request workflowTests— that is what makes the caller file identical everywhere, anddocs/setup.md§4a records it as an interface. This repository was the only holdout.Naming the wrong workflow fails silently: the trigger never matches, no review ever runs, and nothing says why. Leaving
CIwould plant that trap for whoever arms the automatic trigger later.Checked before changing it:
Tests passed, which is a job name and is untouched.workflows: ["CI"]anywhere.ci.yml, so it keeps working; I updated its label to match the new name.If you would rather not rename it, drop that file from this PR and change the commented trigger to
workflows: ["CI"]instead. The rest stands either way.What happens after merge
Nothing automatic. To take the first review:
Or comment
@marketdata-code-reviewon a pull request.The bot reads
REVIEW.mdandpolicy.ymlfrom a pull request's base ref, so both take effect for pull requests opened after this merges.Review rules already in place
REVIEW.mdhere resolves to 411 lines: the shared default, the shared SDK rules including the gotchas section, then section 9 on the C# public surface. It has been correct and inert since sdk-csharp#109.