Skip to content

chore: scrub internal-file ref from proto comment#24

Merged
github-actions[bot] merged 1 commit into
mainfrom
chore/scrub-proto-comment
May 13, 2026
Merged

chore: scrub internal-file ref from proto comment#24
github-actions[bot] merged 1 commit into
mainfrom
chore/scrub-proto-comment

Conversation

@satyakwok
Copy link
Copy Markdown
Member

@satyakwok satyakwok commented May 13, 2026

Companion to #23 — the generated .ts files were scrubbed there, but src/grpc-proto/sentrix.proto (the source) still had the old comment. Patched to match.

Summary by CodeRabbit

  • Chores
    • Updated internal documentation comment in gRPC protocol definitions.

Review Change Stack

The grpc-web TypeScript output here was already neutralized via #23,
but the upstream .proto in src/grpc-proto/ still carried the old line.
Patched to match the canonical phrasing.
@github-actions github-actions Bot enabled auto-merge (squash) May 13, 2026 08:21
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 13, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 6d140760-e090-4295-b9c0-56d4bb82d7ce

📥 Commits

Reviewing files that changed from the base of the PR and between 45de27f and 9ecbc31.

📒 Files selected for processing (1)
  • src/grpc-proto/sentrix.proto

📝 Walkthrough

Walkthrough

This PR updates a single comment line at the top of src/grpc-proto/sentrix.proto. The change replaces a reference to a design doc with a new reference to an internal gRPC service-proto draft design. No protobuf message definitions, service definitions, or RPC signatures are modified.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

Possibly related PRs

  • Sentriscloud/sdk-ts#23: Updates top-of-file comments in other gRPC-related sources (src/grpc-web/sentrix.ts and src/grpc-web/sentrix.client.ts) without modifying runtime code or definitions.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete. While it explains the change and its context, it lacks the required Summary and Test plan sections from the template. Add a structured Summary (1-3 sentences about what changed and why) and a Test plan section with test cases, following the required template format.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: removing an internal-file reference from a proto file comment, which matches the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/scrub-proto-comment

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot merged commit 1ad0a39 into main May 13, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant