Skip to content

docs(reconcile): show scopes in the Role example#1764

Merged
rohilsurana merged 1 commit into
mainfrom
docs/reconcile-role-scopes-example
Jul 17, 2026
Merged

docs(reconcile): show scopes in the Role example#1764
rohilsurana merged 1 commit into
mainfrom
docs/reconcile-role-scopes-example

Conversation

@rohilsurana

Copy link
Copy Markdown
Member

What

Adds scopes to the Role example in the reconcile guide and explains why an exported file
may not show it.

  • The Role YAML example now includes a scopes: line on both a custom role and a
    predefined override, with a short inline note ("resource types this role can attach to").
  • A new paragraph explains the export behavior: a custom role lists its scopes in full, but
    a predefined role lists scopes only when they differ from the shipped default — so a
    role whose scope already matches the default won't show a scopes line, even though the
    scope is still enforced. Same for title.

Why

scopes was already a managed field (and mentioned in the prose), but the example didn't
show it, which led to "is there a way to set a role's scope?" and "why is scopes missing
from the exported files?". The exports omit it for predefined roles whose scope matches the
default — this makes that explicit.

Docs only; no code change.

@vercel

vercel Bot commented Jul 17, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
frontier Ready Ready Preview, Comment Jul 17, 2026 6:11am

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 88dddfbf-648f-4dbe-8e08-1e4f1e9fea09

📥 Commits

Reviewing files that changed from the base of the PR and between 7dcfcee and 71c64ca.

📒 Files selected for processing (1)
  • docs/content/docs/reconcile.mdx

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated Role reconciliation guidance with examples covering custom role scopes.
    • Clarified how scope overrides and role titles appear in exported configurations.
    • Documented differences between custom roles and predefined roles when exporting scopes.

Walkthrough

Changes

Role reconciliation documentation

Layer / File(s) Summary
Role examples and export semantics
docs/content/docs/reconcile.mdx
Role examples now include custom scopes and predefined-role scope overrides, with documentation of scopes and title export behavior.

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.

❤️ Share

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

@rohilsurana
rohilsurana marked this pull request as ready for review July 17, 2026 06:17
@rohilsurana
rohilsurana merged commit ef977a5 into main Jul 17, 2026
8 checks passed
@coveralls

Copy link
Copy Markdown

Coverage Report for CI Build 29559337745

Coverage remained the same at 45.987%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 38426
Covered Lines: 17671
Line Coverage: 45.99%
Coverage Strength: 13.29 hits per line

💛 - Coveralls

@rohilsurana
rohilsurana deleted the docs/reconcile-role-scopes-example branch July 17, 2026 06:17
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.

2 participants