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.

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

lib/ flake: fix lib.version #288812

Merged
merged 4 commits into from
Mar 3, 2024
Merged

Conversation

roberth
Copy link
Member

@roberth roberth commented Feb 14, 2024

Description of changes

Afaik, this makes the lib/ flake fully functional even when the parent directory is dropped, which can be done with:

  • "${./lib}"
  • a path: flakeref
  • a possible Flakes or fetchTree feature
  • a custom flakeref, such as the community-maintained lib mirrors

The latter could be simplified and ideally be made redundant.

This PR is implemented in two commits, for bisection if needed:

  • a conservative change that does not touch <nixpkgs/.version>, and
  • a slightly easier to maintain change that changes it to a symlink.

The third commit tests the version attribute in an isolated lib/ tree.

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/)
  • 24.05 Release Notes (or backporting 23.05 and 23.11 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.

Copy link
Member

@infinisil infinisil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good!

While .version is a core part of Nixpkgs, I'm not very worried for breakage with the symlink. The worst that can happen is probably [[ -f .version ]] failing because it's not a regular file anymore.

@infinisil
Copy link
Member

Oh there's a conflict due to #290831 now that needs to be fixed

Manually tested with

nix-repl> :lf path:lib
nix-repl> lib.version
This way we don't have to make sure they're in sync, and we remove
a small step from the release process.
This is not new and should have been written when .editorconfig
was introduced.
@roberth roberth merged commit 39327e4 into NixOS:master Mar 3, 2024
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants