git.iko.soy/typeable/nixpkgs
on master help sign in
maintainers/scripts/update.nix: Clean up

- Make some arguments more fitting (the path is actually full, not just relative to prefix…). - Increase the purity of packages* functions (they now take pkgs from argument, not from scope). - Add some documentation comments.

commit74a5bb4041bb4ef001875d5b6b26a2105dc24450 authorJan Tojnar <jtojnar@gmail.com> dateSun 20 Sep 2020, 21:12 (6 years ago) parent71c246c
1 file changed+52−30
maintainers/scripts/update.nix+52−30
maintainers/scripts/update.nix+52−30
@@ -32,9 +32,18 @@ let
3232 in
3333 [x] ++ nubOn f xs;
3434
35+ /* Recursively find all packages (derivations) in `pkgs` matching `cond` predicate.
36+
37+ Type: packagesWithPath :: AttrPath → (AttrPath → derivation → bool) → (AttrSet | List) → List<AttrSet{attrPath :: str; package :: derivation; }>
38+ AttrPath :: [str]
39+
40+ The packages will be returned as a list of named pairs comprising of:
41+ - attrPath: stringified attribute path (based on `rootPath`)
42+ - package: corresponding derivation
43+ */
3544 packagesWithPath = rootPath: cond: pkgs:
3645 let
37− packagesWithPathInner = relativePath: pathContent:
46+ packagesWithPathInner = path: pathContent:
3847 let
3948 result = builtins.tryEval pathContent;
4049
@@ -42,24 +51,28 @@ let
4251 in
4352 if result.success then
4453 let
45− pathContent = result.value;
54+ evaluatedPathContent = result.value;
4655 in
47− if lib.isDerivation pathContent then
48− lib.optional (cond relativePath pathContent) { attrPath = lib.concatStringsSep "." relativePath; package = pathContent; }
49− else if lib.isAttrs pathContent then
56+ if lib.isDerivation evaluatedPathContent then
57+ lib.optional (cond path evaluatedPathContent) { attrPath = lib.concatStringsSep "." path; package = evaluatedPathContent; }
58+ else if lib.isAttrs evaluatedPathContent then
5059 # If user explicitly points to an attrSet or it is marked for recursion, we recur.
51− if relativePath == rootPath || pathContent.recurseForDerivations or false || pathContent.recurseForRelease or false then
52− dedupResults (lib.mapAttrsToList (name: elem: packagesWithPathInner (relativePath ++ [name]) elem) pathContent)
60+ if path == rootPath || evaluatedPathContent.recurseForDerivations or false || evaluatedPathContent.recurseForRelease or false then
61+ dedupResults (lib.mapAttrsToList (name: elem: packagesWithPathInner (path ++ [name]) elem) evaluatedPathContent)
5362 else []
54− else if lib.isList pathContent then
55− dedupResults (lib.imap0 (i: elem: packagesWithPathInner (relativePath ++ [i]) elem) pathContent)
63+ else if lib.isList evaluatedPathContent then
64+ dedupResults (lib.imap0 (i: elem: packagesWithPathInner (path ++ [i]) elem) evaluatedPathContent)
5665 else []
5766 else [];
5867 in
5968 packagesWithPathInner rootPath pkgs;
6069
70+ /* Recursively find all packages (derivations) in `pkgs` matching `cond` predicate.
71+ */
6172 packagesWith = packagesWithPath [];
6273
74+ /* Recursively find all packages in `pkgs` with updateScript by given maintainer.
75+ */
6376 packagesWithUpdateScriptAndMaintainer = maintainer':
6477 let
6578 maintainer =
@@ -68,18 +81,19 @@ let
6881 else
6982 builtins.getAttr maintainer' lib.maintainers;
7083 in
71− packagesWith (relativePath: pkg: builtins.hasAttr "updateScript" pkg &&
72− (if builtins.hasAttr "maintainers" pkg.meta
73− then (if builtins.isList pkg.meta.maintainers
74− then builtins.elem maintainer pkg.meta.maintainers
75− else maintainer == pkg.meta.maintainers
76− )
77− else false
78− )
79− )
80− pkgs;
81−
82− packagesWithUpdateScript = path:
84+ packagesWith (path: pkg: builtins.hasAttr "updateScript" pkg &&
85+ (if builtins.hasAttr "maintainers" pkg.meta
86+ then (if builtins.isList pkg.meta.maintainers
87+ then builtins.elem maintainer pkg.meta.maintainers
88+ else maintainer == pkg.meta.maintainers
89+ )
90+ else false
91+ )
92+ );
93+
94+ /* Recursively find all packages under `path` in `pkgs` with updateScript.
95+ */
96+ packagesWithUpdateScript = path: pkgs:
8397 let
8498 prefix = lib.splitString "." path;
8599 pathContent = lib.attrByPath prefix null pkgs;
@@ -87,27 +101,31 @@ let
87101 if pathContent == null then
88102 builtins.throw "Attribute path `${path}` does not exists."
89103 else
90− packagesWithPath prefix (relativePath: pkg: builtins.hasAttr "updateScript" pkg)
104+ packagesWithPath prefix (path: pkg: builtins.hasAttr "updateScript" pkg)
91105 pathContent;
92106
93− packageByName = name:
107+ /* Find a package under `path` in `pkgs` and require that it has an updateScript.
108+ */
109+ packageByName = path: pkgs:
94110 let
95− package = lib.attrByPath (lib.splitString "." name) null pkgs;
111+ package = lib.attrByPath (lib.splitString "." path) null pkgs;
96112 in
97113 if package == null then
98− builtins.throw "Package with an attribute name `${name}` does not exists."
114+ builtins.throw "Package with an attribute name `${path}` does not exists."
99115 else if ! builtins.hasAttr "updateScript" package then
100− builtins.throw "Package with an attribute name `${name}` does not have a `passthru.updateScript` attribute defined."
116+ builtins.throw "Package with an attribute name `${path}` does not have a `passthru.updateScript` attribute defined."
101117 else
102− { attrPath = name; inherit package; };
118+ { attrPath = path; inherit package; };
103119
120+ /* List of packages matched based on the CLI arguments.
121+ */
104122 packages =
105123 if package != null then
106− [ (packageByName package) ]
124+ [ (packageByName package pkgs) ]
107125 else if maintainer != null then
108− packagesWithUpdateScriptAndMaintainer maintainer
126+ packagesWithUpdateScriptAndMaintainer maintainer pkgs
109127 else if path != null then
110− packagesWithUpdateScript path
128+ packagesWithUpdateScript path pkgs
111129 else
112130 builtins.throw "No arguments provided.\n\n${helpText}";
113131
@@ -143,6 +161,8 @@ let
143161 --argstr commit true
144162 '';
145163
164+ /* Transform a matched package into an object for update.py.
165+ */
146166 packageData = { package, attrPath }: {
147167 name = package.name;
148168 pname = lib.getName package;
@@ -152,6 +172,8 @@ let
152172 attrPath = package.updateScript.attrPath or attrPath;
153173 };
154174
175+ /* JSON file with data for update.py.
176+ */
155177 packagesJson = pkgs.writeText "packages.json" (builtins.toJSON (map packageData packages));
156178
157179 optionalArgs =