Add comments to explain about the name defaults
This commit is contained in:
@@ -11,7 +11,11 @@ let
|
|||||||
in
|
in
|
||||||
|
|
||||||
{
|
{
|
||||||
options.services.github-runner = import ./github-runner/options.nix (args // { includeNameDefault = true; });
|
options.services.github-runner = import ./github-runner/options.nix (args // {
|
||||||
|
# Users don't need to specify options.services.github-runner.name; it will default
|
||||||
|
# to the hostname.
|
||||||
|
includeNameDefault = true;
|
||||||
|
});
|
||||||
|
|
||||||
config = mkIf cfg.enable {
|
config = mkIf cfg.enable {
|
||||||
services.github-runners.${cfg.name} = cfg;
|
services.github-runners.${cfg.name} = cfg;
|
||||||
|
|||||||
@@ -14,7 +14,10 @@ in
|
|||||||
{
|
{
|
||||||
options.services.github-runners = mkOption {
|
options.services.github-runners = mkOption {
|
||||||
default = {};
|
default = {};
|
||||||
type = with types; attrsOf (submodule { options = import ./github-runner/options.nix (args // { includeNameDefault = false; }); });
|
type = with types; attrsOf (submodule { options = import ./github-runner/options.nix (args // {
|
||||||
|
# services.github-runners.${name}.name doesn't have a default; instead it is set to ${name} below.
|
||||||
|
includeNameDefault = false;
|
||||||
|
}); });
|
||||||
example = {
|
example = {
|
||||||
runner1 = {
|
runner1 = {
|
||||||
enable = true;
|
enable = true;
|
||||||
|
|||||||
Reference in New Issue
Block a user