docs(reconcile): show scopes in the Role example#1764
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughSummary by CodeRabbit
WalkthroughChangesRole reconciliation documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes 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 |
rohilsurana
marked this pull request as ready for review
July 17, 2026 06:17
Coverage Report for CI Build 29559337745Coverage remained the same at 45.987%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
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.
What
Adds
scopesto the Role example in the reconcile guide and explains why an exported filemay not show it.
scopes:line on both a custom role and apredefined override, with a short inline note ("resource types this role can attach to").
a predefined role lists
scopesonly when they differ from the shipped default — so arole whose scope already matches the default won't show a
scopesline, even though thescope is still enforced. Same for
title.Why
scopeswas already a managed field (and mentioned in the prose), but the example didn'tshow it, which led to "is there a way to set a role's scope?" and "why is
scopesmissingfrom the exported files?". The exports omit it for predefined roles whose scope matches the
default — this makes that explicit.
Docs only; no code change.