diff options
Diffstat (limited to 'nixos/modules/services/continuous-integration/github-runner.nix')
-rw-r--r-- | nixos/modules/services/continuous-integration/github-runner.nix | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/nixos/modules/services/continuous-integration/github-runner.nix b/nixos/modules/services/continuous-integration/github-runner.nix index 19e73582a0904..2da18bbdb3961 100644 --- a/nixos/modules/services/continuous-integration/github-runner.nix +++ b/nixos/modules/services/continuous-integration/github-runner.nix @@ -30,17 +30,17 @@ in url = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Repository to add the runner to. Changing this option triggers a new runner registration. IMPORTANT: If your token is org-wide (not per repository), you need to provide a github org link, not a single repository, so do it like this - <literal>https://github.com/nixos</literal>, not like this - <literal>https://github.com/nixos/nixpkgs</literal>. - Otherwise, you are going to get a <literal>404 NotFound</literal> - from <literal>POST https://api.github.com/actions/runner-registration</literal> + `https://github.com/nixos`, not like this + `https://github.com/nixos/nixpkgs`. + Otherwise, you are going to get a `404 NotFound` + from `POST https://api.github.com/actions/runner-registration` in the configure script. ''; example = "https://github.com/nixos/nixpkgs"; @@ -48,7 +48,7 @@ in tokenFile = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' The full path to a file which contains the runner registration token. The file should contain exactly one line with the token without any newline. The token can be used to re-register a runner of the same name but is time-limited. @@ -61,7 +61,7 @@ in name = mkOption { # Same pattern as for `networking.hostName` type = types.strMatching "^$|^[[:alnum:]]([[:alnum:]_-]{0,61}[[:alnum:]])?$"; - description = '' + description = lib.mdDoc '' Name of the runner to configure. Defaults to the hostname. Changing this option triggers a new runner registration. @@ -73,7 +73,7 @@ in runnerGroup = mkOption { type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' Name of the runner group to add this runner to (defaults to the default runner group). Changing this option triggers a new runner registration. @@ -83,8 +83,8 @@ in extraLabels = mkOption { type = types.listOf types.str; - description = '' - Extra labels in addition to the default (<literal>["self-hosted", "Linux", "X64"]</literal>). + description = lib.mdDoc '' + Extra labels in addition to the default (`["self-hosted", "Linux", "X64"]`). Changing this option triggers a new runner registration. ''; @@ -94,7 +94,7 @@ in replace = mkOption { type = types.bool; - description = '' + description = lib.mdDoc '' Replace any existing runner with the same name. Without this flag, registering a new runner with the same name fails. @@ -104,15 +104,15 @@ in extraPackages = mkOption { type = types.listOf types.package; - description = '' - Extra packages to add to <literal>PATH</literal> of the service to make them available to workflows. + description = lib.mdDoc '' + Extra packages to add to `PATH` of the service to make them available to workflows. ''; default = [ ]; }; package = mkOption { type = types.package; - description = '' + description = lib.mdDoc '' Which github-runner derivation to use. ''; default = pkgs.github-runner; |