Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

lib/types: add types.pathNotInStore #373287

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

lib/types: add types.pathNotInStore #373287

wants to merge 2 commits into from
+34 −17

Conversation

jfly
Copy link
Contributor

@jfly jfly commented Jan 12, 2025

NOTE: This PR depends on #373285 (which is why there are 2 commits in here). Please review/merge #373285 before this one! One it's merged, I'll rebase this and take it out of draft state.

This option parallels our existing types.pathInStore type. This is
useful for when a module needs a path to a file, and wants to protect
people from accidentally leaking that file into the nix store.

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

jfly added 2 commits January 12, 2025 13:10
@jfly
lib/types: change pathInStore to allow leading period
3766aa0 
As of [nix v2.21.0](https://nix.dev/manual/nix/2.25/release-notes/rl-2.21.html):

> Store paths are allowed to start with `.`

I'm not entirely sure what range of versions of `nix` we try to stay
compatible with over here in `nixpkgs`. That said, I don't think
particular change would cause issues for people using a version of `nix`
that doesn't support leading periods.
@jfly
lib/types: add types.pathNotInStore
c377630 
This option parallels our existing `types.pathInStore` type. This is
useful for when a module needs a path to a file, and wants to protect
people from accidentally leaking that file into the nix store.
@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` 6.topic: module system About "NixOS" module system internals 6.topic: lib The Nixpkgs function library labels Jan 12, 2025
@jfly jfly mentioned this pull request Jan 12, 2025
Merged
13 tasks
@jfly jfly mentioned this pull request Jan 13, 2025
Open
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SuperSandro2000 SuperSandro2000 Awaiting requested review from SuperSandro2000

@roberth roberth Awaiting requested review from roberth

@infinisil infinisil Awaiting requested review from infinisil

Assignees
No one assigned
Labels
6.topic: lib The Nixpkgs function library 6.topic: module system About "NixOS" module system internals 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@jfly