From ab57ba24cf62c16530ac7bf303c21339235015d1 Mon Sep 17 00:00:00 2001 From: Vincent Haupert Date: Mon, 22 Jan 2024 13:34:36 +0100 Subject: 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. --- .../modules/services/continuous-integration/github-runner/options.nix | 4 ++++ 1 file changed, 4 insertions(+) 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; }; -- cgit 1.4.1