docs(getting-started/testing): update examples to use YAML and add de… #2603
Conversation
…pth config details
WalkthroughUpdated testing documentation: converted multiple example fences from JavaScript to YAML, added a new "Depth Configuration" section describing depth usage and defaults, expanded example blocks with depth-related fields, and adjusted contextual notes and links to reflect depth-enabled checks and filters. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
🔇 Additional comments (2)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/getting-started/testing.mdx (2)
228-237: Replace invalid//YAML comments with#comments in entity_filters example.Same YAML syntax issue:
//is not valid in YAML; use#for comments.Apply this diff to fix the YAML syntax:
```yaml entity_filters: - - entity_type: "repository" // entity that you want to filter - subject: "user:1" // subject that you want to perform data filtering - depth: 100 // depth limit for permission check (optional, default: 100, minimum: 3) - context: null // additional data provided during an access check to be evaluated + - entity_type: "repository" # entity that you want to filter + subject: "user:1" # subject that you want to perform data filtering + depth: 100 # depth limit for permission check (optional, default: 100, minimum: 3) + context: null # additional data provided during an access check to be evaluated assertions: push : ["1", "3", "4", "5"] // IDs of the resources that we expected to return edit : []--- `245-253`: **Replace invalid `//` YAML comments with `#` comments in subject_filters example.** Same YAML syntax issue: `//` is not valid in YAML; use `#` for comments. Apply this diff to fix the YAML syntax: ```diff ```yaml - subject_reference: "user" entity: "repository:1" - depth: 100 // depth limit for permission check (optional, default: 100, minimum: 3) - context: null // additional data provided during an access check to be evaluated + depth: 100 # depth limit for permission check (optional, default: 100, minimum: 3) + context: null # additional data provided during an access check to be evaluated assertions: - push : ["1", "43"] // IDs of the users that we expected to return + push : ["1", "43"] # IDs of the users that we expected to return - edit : ["58"] + edit : ["58"]</blockquote></details> </blockquote></details>📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/getting-started/testing.mdx(4 hunks)⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Test with Coverage
- GitHub Check: Analyze (go)
- GitHub Check: Scan Container for Vulnerabilities
- GitHub Check: Test with Coverage
🔇 Additional comments (1)
docs/getting-started/testing.mdx (1)
192-217: Depth Configuration section is well-structured and comprehensive.The new Depth Configuration section clearly explains the depth parameter with defaults, minimums, usage guidelines, and practical examples. Once the YAML syntax issues are fixed, this addition will significantly improve user understanding of how to optimize permission checks.
…pth config details
Summary by CodeRabbit