about summary refs log tree commit diff
diff options
context:
space:
mode:
authorVincent Haupert <vincent@yaxi.tech>2024-01-22 13:34:36 +0100
committerVincent Haupert <vincent@yaxi.tech>2024-02-09 15:14:32 +0100
commitab57ba24cf62c16530ac7bf303c21339235015d1 (patch)
treeb7f49ab3a060fed63fb6fd872ffbc150c4e6f616
parenta9c807496f102e37de0f8f88b8d8a72619c560e2 (diff)
downloadnixlib-ab57ba24cf62c16530ac7bf303c21339235015d1.tar
nixlib-ab57ba24cf62c16530ac7bf303c21339235015d1.tar.gz
nixlib-ab57ba24cf62c16530ac7bf303c21339235015d1.tar.bz2
nixlib-ab57ba24cf62c16530ac7bf303c21339235015d1.tar.lz
nixlib-ab57ba24cf62c16530ac7bf303c21339235015d1.tar.xz
nixlib-ab57ba24cf62c16530ac7bf303c21339235015d1.tar.zst
nixlib-ab57ba24cf62c16530ac7bf303c21339235015d1.zip
nixos/github-runners: document new runner registrations
Make the documentation of the options `workDir` and `ephemeral` reflect
that changing these options will trigger a new runner registration.
-rw-r--r--nixos/modules/services/continuous-integration/github-runner/options.nix4
1 files changed, 4 insertions, 0 deletions
diff --git a/nixos/modules/services/continuous-integration/github-runner/options.nix b/nixos/modules/services/continuous-integration/github-runner/options.nix
index 6507e4cc5be1..1ee8067e47ea 100644
--- a/nixos/modules/services/continuous-integration/github-runner/options.nix
+++ b/nixos/modules/services/continuous-integration/github-runner/options.nix
@@ -189,6 +189,8 @@ with lib;
       You should only enable this option if `tokenFile` points to a file which contains a
       personal access token (PAT). If you're using the option with a registration token, restarting the
       service will fail as soon as the registration token expired.
+
+      Changing this option triggers a new runner registration.
     '';
     default = false;
   };
@@ -210,6 +212,8 @@ with lib;
       The service cleans this directory on every service start.
 
       A value of `null` will default to the systemd `RuntimeDirectory`.
+
+      Changing this option triggers a new runner registration.
     '';
     default = null;
   };