Commit 5221e7af authored by Tom McLaughlin's avatar Tom McLaughlin
Browse files

Add comments to explain about the name defaults

parent 2c099d1a

nixos/modules/services/continuous-integration/github-runner.nix

+5 −1
Original line number Diff line number Diff line
@@ -11,7 +11,11 @@ let 
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 {

    services.github-runners.${cfg.name} = cfg;

nixos/modules/services/continuous-integration/github-runners.nix

+4 −1
Original line number Diff line number Diff line
@@ -14,7 +14,10 @@ in 
{

  options.services.github-runners = mkOption {

    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 = {

      runner1 = {

        enable = true;