chore: document required nix option#1609
Conversation
|
Warning Review limit reached
Next review available in: 56 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. 📝 WalkthroughWalkthroughAdds a README Prerequisites Update
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
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.
Pull request overview
Documents a required Nix configuration option so developers following the README don’t hit failures when running just build / other Nix commands.
Changes:
- Adds a README note to enable
nix-commandandflakesviaexperimental-featuresinnix.conf.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
24-27: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winClarify configuration path alternatives and affected commands.
The note only mentions
/etc/nix/nix.conf, which requires root and is system-wide. Since the prerequisites recommend single-user Nix installation, users may not have write access to/etc/nix/nix.conf. Nix also respects per-user configuration at~/.config/nix/nix.conf(or$XDG_CONFIG_HOME/nix/nix.conf). Consider mentioning this as an alternative path.Additionally, "some commands will fail" is vague. Since the PR description indicates
just buildfailed without this setting, specify the nix-related commands that require these experimental features (e.g.,nix-shell,nix build,nix develop).> [!NOTE] -> Make sure to add `experimental-features = nix-command flakes` to `/etc/nix/nix.conf`, or some commands will fail +> Make sure to add `experimental-features = nix-command flakes` to `/etc/nix/nix.conf` (or `~/.config/nix/nix.conf` for per-user config), or nix commands like `nix-shell` and `just build` will fail🤖 Prompt for 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. In `@README.md` around lines 24 - 27, Update the note in README.md to mention both the system-wide Nix config path and the per-user alternative so it matches single-user installs: reference the existing nix.conf guidance and add ~/.config/nix/nix.conf (or $XDG_CONFIG_HOME/nix/nix.conf) as an option. Also replace the vague “some commands will fail” wording with the specific Nix commands affected, using the current note text to point readers toward nix-shell, nix build, nix develop, and any build flow such as just build that depends on them.
🤖 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.
Nitpick comments:
In `@README.md`:
- Around line 24-27: Update the note in README.md to mention both the
system-wide Nix config path and the per-user alternative so it matches
single-user installs: reference the existing nix.conf guidance and add
~/.config/nix/nix.conf (or $XDG_CONFIG_HOME/nix/nix.conf) as an option. Also
replace the vague “some commands will fail” wording with the specific Nix
commands affected, using the current note text to point readers toward
nix-shell, nix build, nix develop, and any build flow such as just build that
depends on them.
following just the installation notes in the README I was not able to run 'just build' until someone pointed out to me the required option in nix.conf, so let's make sure future developers will not hit the same issue Signed-off-by: Emanuele Di Pascale <emanuele@githedgehog.com>
edipascale
force-pushed
the
ema/document-nix-trick
branch
from
74bf034 to
c8eddf0
Compare
Fredi-raspall
left a comment
Fredi-raspall
left a comment
There was a problem hiding this comment.
LGTM, thanks @edipascale !
following just the installation notes in the README I was not able to run 'just build' until someone pointed out to me the required option in nix.conf, so let's make sure future developers will not hit the same issue