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.
This commit is contained in:
Vincent Haupert 2024-01-22 13:34:36 +01:00
parent a9c807496f
commit ab57ba24cf

View File

@ -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;
};