diff options
Diffstat (limited to 'nixos/modules/services/continuous-integration/buildkite-agents.nix')
| -rw-r--r-- | nixos/modules/services/continuous-integration/buildkite-agents.nix | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/nixos/modules/services/continuous-integration/buildkite-agents.nix b/nixos/modules/services/continuous-integration/buildkite-agents.nix index 2e488f83d4c3b..fc30172c64999 100644 --- a/nixos/modules/services/continuous-integration/buildkite-agents.nix +++ b/nixos/modules/services/continuous-integration/buildkite-agents.nix @@ -19,38 +19,38 @@ let enable = lib.mkOption { default = true; type = lib.types.bool; - description = lib.mdDoc "Whether to enable this buildkite agent"; + description = "Whether to enable this buildkite agent"; }; package = lib.mkOption { default = pkgs.buildkite-agent; defaultText = lib.literalExpression "pkgs.buildkite-agent"; - description = lib.mdDoc "Which buildkite-agent derivation to use"; + description = "Which buildkite-agent derivation to use"; type = lib.types.package; }; dataDir = lib.mkOption { default = "/var/lib/buildkite-agent-${name}"; - description = lib.mdDoc "The workdir for the agent"; + description = "The workdir for the agent"; type = lib.types.str; }; extraGroups = lib.mkOption { default = [ "keys" ]; - description = lib.mdDoc "Groups the user for this buildkite agent should belong to"; + description = "Groups the user for this buildkite agent should belong to"; type = lib.types.listOf lib.types.str; }; runtimePackages = lib.mkOption { default = [ pkgs.bash pkgs.gnutar pkgs.gzip pkgs.git pkgs.nix ]; defaultText = lib.literalExpression "[ pkgs.bash pkgs.gnutar pkgs.gzip pkgs.git pkgs.nix ]"; - description = lib.mdDoc "Add programs to the buildkite-agent environment"; + description = "Add programs to the buildkite-agent environment"; type = lib.types.listOf lib.types.package; }; tokenPath = lib.mkOption { type = lib.types.path; - description = lib.mdDoc '' + description = '' The token from your Buildkite "Agents" page. A run-time path to the token file, which is supposed to be provisioned @@ -61,7 +61,7 @@ let name = lib.mkOption { type = lib.types.str; default = "%hostname-${name}-%n"; - description = lib.mdDoc '' + description = '' The name of the agent as seen in the buildkite dashboard. ''; }; @@ -70,7 +70,7 @@ let type = lib.types.attrsOf (lib.types.either lib.types.str (lib.types.listOf lib.types.str)); default = { }; example = { queue = "default"; docker = "true"; ruby2 = "true"; }; - description = lib.mdDoc '' + description = '' Tags for the agent. ''; }; @@ -79,7 +79,7 @@ let type = lib.types.lines; default = ""; example = "debug=true"; - description = lib.mdDoc '' + description = '' Extra lines to be added verbatim to the configuration file. ''; }; @@ -91,7 +91,7 @@ let ## don't end up in the Nix store. apply = final: if final == null then null else toString final; - description = lib.mdDoc '' + description = '' OpenSSH private key A run-time path to the key file, which is supposed to be provisioned @@ -108,7 +108,7 @@ let export SECRET_VAR=`head -1 /run/keys/secret` '''; }''; - description = lib.mdDoc '' + description = '' "Agent" hooks to install. See <https://buildkite.com/docs/agent/v3/hooks> for possible options. ''; @@ -118,7 +118,7 @@ let type = lib.types.path; default = hooksDir config.hooks; defaultText = lib.literalMD "generated from {option}`services.buildkite-agents.<name>.hooks`"; - description = lib.mdDoc '' + description = '' Path to the directory storing the hooks. Consider using {option}`services.buildkite-agents.<name>.hooks.<name>` instead. @@ -129,7 +129,7 @@ let type = lib.types.str; default = "${pkgs.bash}/bin/bash -e -c"; defaultText = lib.literalExpression ''"''${pkgs.bash}/bin/bash -e -c"''; - description = lib.mdDoc '' + description = '' Command that buildkite-agent 3 will execute when it spawns a shell. ''; }; @@ -142,7 +142,7 @@ in options.services.buildkite-agents = lib.mkOption { type = lib.types.attrsOf (lib.types.submodule buildkiteOptions); default = { }; - description = lib.mdDoc '' + description = '' Attribute set of buildkite agents. The attribute key is combined with the hostname and a unique integer to create the final agent name. This can be overridden by setting the `name` |