mirror of
https://github.com/hercules-ci/flake-parts.git
synced 2024-12-14 11:47:31 +00:00
Add flakeModules.partitions
This commit is contained in:
parent
c07ef7e578
commit
0d5122e84c
2 changed files with 131 additions and 0 deletions
130
extras/partitions.nix
Normal file
130
extras/partitions.nix
Normal file
|
@ -0,0 +1,130 @@
|
|||
{ lib, config, inputs, extendModules, partitionStack, self, ... }:
|
||||
let
|
||||
inherit (lib)
|
||||
literalMD
|
||||
mapAttrs
|
||||
mkOption
|
||||
optionalAttrs
|
||||
types
|
||||
;
|
||||
|
||||
partitionModule = { config, options, name, ... }: {
|
||||
options = {
|
||||
extraInputsFlake = mkOption {
|
||||
type = types.raw;
|
||||
default = { };
|
||||
description = ''
|
||||
Location of a flake whose inputs to add to the inputs module argument in the partition.
|
||||
'';
|
||||
};
|
||||
extraInputs = mkOption {
|
||||
type = types.lazyAttrsOf types.raw;
|
||||
description = ''
|
||||
Extra inputs to add to the inputs module argument in the partition.
|
||||
|
||||
This can be used as a workaround for the fact that transitive inputs are locked in the "end user" flake.
|
||||
That's not desirable for inputs they don't need, such as development inputs.
|
||||
'';
|
||||
default = { };
|
||||
defaultText = literalMD ''
|
||||
if `extraInputsFlake` is set, then `builtins.getFlake extraInputsFlake`, else `{ }`
|
||||
'';
|
||||
};
|
||||
module = mkOption {
|
||||
type = (extendModules {
|
||||
specialArgs =
|
||||
let
|
||||
inputs2 = inputs // config.extraInputs // {
|
||||
self = self2;
|
||||
};
|
||||
self2 = self // {
|
||||
inputs = inputs2;
|
||||
};
|
||||
in
|
||||
{
|
||||
inputs = inputs2;
|
||||
self = self2;
|
||||
partitionStack = partitionStack ++ [ name ];
|
||||
};
|
||||
}).type;
|
||||
default = { };
|
||||
description = ''
|
||||
A re-evaluation of the flake-parts top level modules.
|
||||
|
||||
You may define config definitions, imports, etc here, and it can be read like any other submodule.
|
||||
'';
|
||||
};
|
||||
};
|
||||
config = {
|
||||
extraInputs = lib.mkIf options.extraInputsFlake.isDefined (
|
||||
let
|
||||
p = options.extraInputsFlake.value;
|
||||
flake =
|
||||
if builtins.typeOf p == "path"
|
||||
then get-flake p
|
||||
else builtins.getFlake p;
|
||||
in
|
||||
flake.inputs
|
||||
);
|
||||
};
|
||||
};
|
||||
|
||||
# Nix does not recognize that a flake like "${./dev}", which is a content
|
||||
# addressed store path is a pure input, so we have to fetch and wire it
|
||||
# manually with get-flake.
|
||||
# TODO: update this
|
||||
get-flake = import (builtins.fetchTree {
|
||||
type = "github";
|
||||
owner = "ursi";
|
||||
repo = "get-flake";
|
||||
rev = "a6c57417d1b857b8be53aba4095869a0f438c502";
|
||||
});
|
||||
|
||||
in
|
||||
{
|
||||
options = {
|
||||
partitionedAttrs = mkOption {
|
||||
type = types.attrsOf types.str;
|
||||
default = { };
|
||||
description = ''
|
||||
A set of flake output attributes that are taken from a partition instead of the default top level flake-parts evaluation.
|
||||
|
||||
The attribute name refers to the flake output attribute name, and the value is the name of the partition to use.
|
||||
|
||||
The flake attributes are overridden with `lib.mkForce` priority.
|
||||
|
||||
See the `partitions` options to understand the purpose.
|
||||
'';
|
||||
};
|
||||
partitions = mkOption {
|
||||
type = types.attrsOf (types.submodule partitionModule);
|
||||
default = { };
|
||||
description = ''
|
||||
By partitioning the flake, you can avoid fetching inputs that are not
|
||||
needed for the evaluation of a particular attribute.
|
||||
|
||||
Each partition is a distinct module system evaluation. This allows
|
||||
attributes of the final flake to be defined by multiple sets of modules,
|
||||
so that for example the `packages` attribute can be evaluated without
|
||||
loading development related inputs.
|
||||
|
||||
While the module system does a good job at preserving laziness, the fact
|
||||
that a development related import can define `packages` means that
|
||||
in order to evaluate `packages`, you need to evaluate at least to the
|
||||
point where you can conclude that the development related import does
|
||||
not actually define a `packages` attribute. While the actual evaluation
|
||||
is cheap, it can only happen after fetching the input, which is not
|
||||
as cheap.
|
||||
'';
|
||||
};
|
||||
};
|
||||
config = {
|
||||
# Default, overriden with specialArgs inside partitions.
|
||||
_module.args.partitionStack = [ ];
|
||||
flake = optionalAttrs (partitionStack == [ ]) (
|
||||
mapAttrs
|
||||
(attrName: partition: lib.mkForce (config.partitions.${partition}.module.flake.${attrName}))
|
||||
config.partitionedAttrs
|
||||
);
|
||||
};
|
||||
}
|
|
@ -48,6 +48,7 @@
|
|||
flakeModules = {
|
||||
easyOverlay = ./extras/easyOverlay.nix;
|
||||
flakeModules = ./extras/flakeModules.nix;
|
||||
partitions = ./extras/partitions.nix;
|
||||
};
|
||||
in
|
||||
lib.mkFlake { inherit inputs; } {
|
||||
|
|
Loading…
Reference in a new issue