Skip to content

docs: note for inputs.self.submodules #92

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

Open
definfo wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: note for inputs.self.submodules #92

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,32 @@ Afterwards, create a `default.nix` file containing the following:
) { src = ./.; }).defaultNix
```

NOTE: Flake fetcher is aware of Git submodules when `inputs.self.submodules` is set to `true` in `flake.nix`.
For compatibility in stable Nix, paste the following content in `default.nix` instead:

```nix
let
lock = builtins.fromJSON (builtins.readFile ./flake.lock);

fetchFromLockFile =
nodeName:
fetchTarball {
url =
lock.nodes.${nodeName}.locked.url
or "https://github.com/${lock.nodes.${nodeName}.locked.owner}/${lock.nodes.${nodeName}.locked.repo}/archive/${lock.nodes.${nodeName}.locked.rev}.tar.gz";
sha256 = lock.nodes.${nodeName}.locked.narHash;
};

lib = (import (fetchFromLockFile lock.nodes.root.inputs.nixpkgs) { }).lib;
in
(import (fetchFromLockFile lock.nodes.root.inputs.flake-compat) {
src = lib.fileset.toSource {
root = ./.;
fileset = (lib.fileset.gitTrackedWith { recurseSubmodules = true; }) ./.;
};
}).defaultNix
```

If you would like a `shell.nix` file, create one containing the above, replacing `defaultNix` with `shellNix`.

You can access any flake output via the `outputs` attribute returned by `flake-compat`, e.g.
Expand Down