home-manager/modules/misc/version.nix

84 lines
2.3 KiB
Nix
Raw Normal View History

2018-11-23 00:18:29 +01:00
{ config, lib, ... }:
with lib;
2023-07-15 17:47:19 +02:00
let releaseInfo = lib.importJSON ../../release.json;
in {
2018-11-23 00:18:29 +01:00
options = {
home.stateVersion = mkOption {
2021-06-05 20:05:04 +02:00
type = types.enum [
"18.09"
"19.03"
"19.09"
"20.03"
"20.09"
"21.03"
"21.05"
"21.11"
"22.05"
2022-06-01 21:34:23 +02:00
"22.11"
2022-11-24 23:13:38 +01:00
"23.05"
"23.11"
2021-06-05 20:05:04 +02:00
];
2018-11-23 00:18:29 +01:00
description = ''
It is occasionally necessary for Home Manager to change
configuration defaults in a way that is incompatible with
stateful data. This could, for example, include switching the
default data format or location of a file.
</para><para>
The <emphasis>state version</emphasis> indicates which default
settings are in effect and will therefore help avoid breaking
program configurations. Switching to a higher state version
typically requires performing some manual steps, such as data
conversion or moving files.
'';
};
home.version = {
full = mkOption {
internal = true;
readOnly = true;
type = types.str;
default = let
inherit (config.home.version) release revision;
suffix =
optionalString (revision != null) "+${substring 0 8 revision}";
in "${release}${suffix}";
example = "22.11+213a0629";
description = "The full Home Manager version.";
};
release = mkOption {
internal = true;
readOnly = true;
type = types.str;
2023-07-15 17:47:19 +02:00
default = releaseInfo.release;
example = "22.11";
description = "The Home Manager release.";
};
2023-07-15 17:47:19 +02:00
isReleaseBranch = mkOption {
internal = true;
readOnly = true;
type = types.bool;
default = releaseInfo.isReleaseBranch;
description = ''
Whether the Home Manager version is from a versioned
release branch.
'';
};
revision = mkOption {
internal = true;
type = types.nullOr types.str;
default = let gitRepo = "${toString ./../..}/.git";
in if pathIsGitRepo gitRepo then commitIdFromGitRepo gitRepo else null;
description = ''
The Git revision from which this Home Manager configuration was built.
'';
};
};
2018-11-23 00:18:29 +01:00
};
}