docs: document local Nix setup with the OpenShell binary cache
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 84/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- markdown
- Domain
- documentation
Research direction
Start with CONTRIBUTING.md and check the existing prerequisites section to place the Nix setup guidance. Explain the recommended installer, binary cache configuration and verification command from the issue, then link to that section from TESTING.md and nix/test-guest/README.md. Run mise run markdown:lint; done means the section and both links are present and the lint command passes.
Written by the indexing model from the issue text.
Description
User Story
I develop OpenShell on macOS (Apple Silicon) and use nix develop and nix run .#tmachine / .#build-artifacts-* to run tmachine environments locally. On a fresh Nix install the first build took over an hour, and an earlier non-standard Nix install broke TLS for host-side tools, so I need the contributor docs to say how to set Nix up the way CI does.
Description
Add a short Nix setup section to the contributor prerequisites:
- Recommend Determinate Nix, which CI uses. Some other installers leave Nix's OpenSSL without a CA bundle on macOS (no default profile, no
NIX_SSL_CERT_FILE), which breaks HTTPS from Nix-provided tools such asansible-galaxy(see #4930). - Explain that
flake.nix'snixConfigsubstituter is ignored for non-trusted users, and how to addhttps://openshell.cachix.organd its key to the system Nix config and restart the daemon, without adding the user totrusted-users. - Note that the "ignoring untrusted flake configuration setting" warnings are harmless, and that
nix config show substitutersis the check. - Link to it from TESTING.md and the test-guest README instead of repeating it.
Context
Found while running #4773's tmachine runner locally. Without the cache, nix build --dry-run .#devShells.aarch64-darwin.default has 88 derivations to build (including cross GCC); with it, 1.
Definition of Done
- CONTRIBUTING.md has a Nix setup section covering the installer, the binary cache and how to verify it.
- TESTING.md and
nix/test-guest/README.mdlink to it. -
mise run markdown:lintpasses.
- Dominant language
- Rust
- Stars
- 17.1k
- Forks
- 1.8k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 314
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from NVIDIA/OpenShell
-
bug(python): OIDC refresh drops the gateway's oidc_scopesPossibly taken @jyotir07 claimed this today. Openstate:triage-needed
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
NVIDIA/OpenShell#4919 · 3 comments ·
Maintainers usually reply within 1 day
-
bug: workspace access hint suggests a --subject command that fails for hyphen-leading OIDC subjectsMay be free again A pull request for this issue was closed without being merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
state:triage-needed
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
bug(install): install.sh prints gawk "escape sequence \. treated as plain ." warnings on RPM hostsPossibly taken @ericcurtin claimed this 4 days ago. Openstate:triage-needed
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
All issues in NVIDIA/OpenShell
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
manuscript-lang/manuscript#1629 ·
Maintainers usually reply within 1 day
-
autofixer: follow-up
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
tursodatabase/turso#10885 ·
Maintainers usually reply within 1 day
-
🐞 bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
nannou-org/gantz#475 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day