Add profile id migration#781
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocumentation clarifies NetBird's multi-profile model (non-unique display names with generated IDs stored as ChangesProfile Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
src/pages/client/profiles.mdxOops! Something went wrong! :( ESLint: 9.39.4 TypeError: Converting circular structure to JSON 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/pages/client/profiles.mdx`:
- Around line 132-134: Update the top-level CLI usage placeholder string
"netbird profile <add|list|select|remove> [name|id]" to reflect that
select/remove also accept ID-prefix handles: change the bracketed operand to
include handle (e.g., "[name|id|handle]" or similar) so the documented usage for
the command symbol netbird profile and actions select/remove explicitly permits
handles while preserving name/id semantics for add/list.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: cd7ac6d9-1092-440a-9057-609d22c26a78
📒 Files selected for processing (2)
src/pages/client/profiles.mdxsrc/pages/get-started/cli.mdx
riccardomanfrin
left a comment
riccardomanfrin
left a comment
There was a problem hiding this comment.
Doc is great, I would add a note or clarify clearly about precedence and corner case (e.g. "AB" profile name / handles)
| it, the rename still succeeds and a warning is printed (same as `add`). | ||
| * The **default profile can be renamed**. Its label changes everywhere it's shown, but it keeps | ||
| its reserved `default` ID and still cannot be removed. | ||
| * If the handle is ambiguous or matches no profile, you'll get the same errors as `select` and |
There was a problem hiding this comment.
maybe describe what is "handle"
2 participants
This PR updates the docs with the new profile ids and names.
Summary by CodeRabbit
defaultID.profilecommands now clearly describe selectors (ID, unique-ID prefix, or unique name handle) and improved not-found vs ambiguous error examples.profile add/rename/removebehavior documented in detail, including short-ID output, rename scope (display name only), and blocking removal of active/default while removing related config/state for inactive profiles.--profileflag documented to resolve using the same handle rules and prompt for authentication when needed.