docs: document NH_FILE and NH_ATTRP env vars#686
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughThis PR adds documentation for two environment variables (NH_FILE and NH_ATTRP) used by ChangesEnvironment Variable Documentation
Possibly related PRs
Suggested reviewers
🚥 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. 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: 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 `@docs/README.md`:
- Around line 351-355: The README example has a typo: it uses NH_ATTPR but the
implemented env var is NH_ATTRP; update the example expression to use NH_ATTRP
so it matches the implementation in installable.rs (the NH_FILE/NH_ATTRP
handling in crates/nh-core/src/installable.rs). Ensure both mentions of the
attribute variable in the docs and the example expression are corrected to
NH_ATTRP to avoid confusion.
🪄 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: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 219d32e6-b2f9-4aa7-95e8-6ec320c7f66b
📒 Files selected for processing (2)
docs/README.mdxtask/src/man.rs
31c0e9f to
547e60a
Compare
|
Thanks :) |
Sanity Checking
nix fmtto format my Nix codecargo fmtto format my Rust codecargo clippyand fixed any new linter warnings.logic
description.
x86_64-linuxaarch64-linuxx86_64-darwinaarch64-darwinAdd a 👍 reaction to pull requests you find important.
Putting this up because I recently switched from using a flake based config to a non-flake config. I had been running
nh os switch --file . nixosConfigurations.<hostname>from my local clone of my nix config repo, but also saw these two vars in the codebase.These two vars were not previously documented in the README at
docs/README.mdor the man-page atxtasks/src/man.rs, but they are entirely functional, similar toNH_FLAKE, implemented incrates/nh-core/src/installable.rs. So, I am simply documenting them so others feel confident using them in their nix/nixos configs.After these changes in my config, I can run
nh os switchfrom anywhere on nixos to switch, so these vars definitely work as expected. I'll test this on darwin as well but I suspect the results will be the same.