Skip to content

Add documentation for glob pattern#74

Merged
rustatian merged 2 commits intoroadrunner-server:masterfrom
Nyholm:glob
Mar 13, 2026
Merged

Add documentation for glob pattern#74
rustatian merged 2 commits intoroadrunner-server:masterfrom
Nyholm:glob

Conversation

@Nyholm
Copy link
Copy Markdown
Contributor

@Nyholm Nyholm commented Mar 12, 2026

Documentation for PR roadrunner-server/grpc#145

Summary by CodeRabbit

  • New Features

    • Proto field configuration now accepts glob patterns, enabling specification of multiple proto files with wildcards (e.g., "some/path/**/*.proto").
  • Documentation

    • Updated docs and examples to clarify glob pattern support for proto field specifications in version 2025.1.9 and later.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 12, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0a3b2c68-779e-4fd8-b3dd-bf3ea5ace4b6

📥 Commits

Reviewing files that changed from the base of the PR and between ed06b88 and d7dee60.

📒 Files selected for processing (1)
  • grpc/grpc.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • grpc/grpc.md

📝 Walkthrough

Walkthrough

Documentation updated to reflect glob pattern support for proto file specification in grpc configuration, effective as of version 2025.1.9. Examples added showing the some/path/**/*.proto syntax in both hint and configuration examples.

Changes

Cohort / File(s) Summary
Documentation Update
grpc/grpc.md
Updated proto field documentation to document glob pattern support (e.g., some/path/**/*.proto) as of version 2025.1.9, with examples added to both hint and configuration sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A glob hops lightly across the proto field,
Gathering paths where many files yield,
"some/path/**/*.proto" twirls in the sun,
Patterns matched, the examples done,
A rabbit cheers — changes neatly spun!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add documentation for glob pattern' directly and clearly summarizes the main change in the PR, which is adding documentation for glob pattern support in proto files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
grpc/grpc.md (1)

448-455: Clarify that the new behavior is recursive ** matching.

*.proto is already a glob, so the current wording makes the old and new capabilities sound interchangeable. Calling out recursive/globstar support explicitly would make the example at Line 455 much clearer.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@grpc/grpc.md` around lines 448 - 455, The documentation currently treats
"*.proto" and "some/path/**/*.proto" as similar globs; clarify that the new
behavior adds recursive "globstar" support by explicitly stating that "**"
performs recursive directory matching (i.e., matches across multiple directory
levels), update the description for the proto field to mention that "*.proto"
matches files in a single directory while "some/path/**/*.proto" uses globstar
to match recursively through subdirectories, and ensure the example lines
(proto: - "*.proto" - "first.proto" - "second.proto" - "some/path/**/*.proto")
reflect this by adding a short note or parenthetical explaining the difference.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@grpc/grpc.md`:
- Line 346: Replace the prose "As of [2025.1.9]" with the repository's
version-tag format "[>=2025.1.9]" in the sentence that reads "You can define
multiple proto files in the `proto` section. As of [2025.1.9], one can use glob
patterns to specify multiple proto files." (also apply the same change to the
similar note at the other occurrence). Ensure both instances use the exact tag
"[>=2025.1.9]" so the docs consistently mark the support boundary.

---

Nitpick comments:
In `@grpc/grpc.md`:
- Around line 448-455: The documentation currently treats "*.proto" and
"some/path/**/*.proto" as similar globs; clarify that the new behavior adds
recursive "globstar" support by explicitly stating that "**" performs recursive
directory matching (i.e., matches across multiple directory levels), update the
description for the proto field to mention that "*.proto" matches files in a
single directory while "some/path/**/*.proto" uses globstar to match recursively
through subdirectories, and ensure the example lines (proto: - "*.proto" -
"first.proto" - "second.proto" - "some/path/**/*.proto") reflect this by adding
a short note or parenthetical explaining the difference.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 97a9dcd5-531b-4934-9672-a21a681b5ad5

📥 Commits

Reviewing files that changed from the base of the PR and between 0667084 and ed06b88.

📒 Files selected for processing (1)
  • grpc/grpc.md

@rustatian rustatian added the enhancement New feature or request label Mar 13, 2026
@rustatian
Copy link
Copy Markdown
Member

Thank you @Nyholm 👍🏻

@rustatian rustatian merged commit b077818 into roadrunner-server:master Mar 13, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants