summaryrefslogtreecommitdiff
path: root/modules/services/github-runner/options.nix
diff options
context:
space:
mode:
authorWeijia Wang <9713184+wegank@users.noreply.github.com>2024-04-14 23:02:32 +0200
committerWeijia Wang <9713184+wegank@users.noreply.github.com>2024-04-19 04:05:50 +0200
commitdef1e23be848848400d1d097d4f044e3c401f9dd (patch)
tree7a69686dea36e304c788531fda90bc3edeee86fd /modules/services/github-runner/options.nix
parent99b3f9a1f5d2604d542f367d38001dfa40eea7b9 (diff)
treewide: remove lib.mdDoc
Diffstat (limited to 'modules/services/github-runner/options.nix')
-rw-r--r--modules/services/github-runner/options.nix34
1 files changed, 17 insertions, 17 deletions
diff --git a/modules/services/github-runner/options.nix b/modules/services/github-runner/options.nix
index 300ca32..f6c4830 100644
--- a/modules/services/github-runner/options.nix
+++ b/modules/services/github-runner/options.nix
@@ -6,7 +6,7 @@
with lib;
{
options.services.github-runners = mkOption {
- description = mdDoc ''
+ description = ''
Multiple GitHub Runners.
If `user` and `group` are set to `null`, the module will configure nix-darwin to
@@ -50,7 +50,7 @@ with lib;
enable = mkOption {
default = false;
example = true;
- description = mdDoc ''
+ description = ''
Whether to enable GitHub Actions runner.
Note: GitHub recommends using self-hosted runners with private repositories only. Learn more here:
@@ -61,7 +61,7 @@ with lib;
url = mkOption {
type = types.str;
- description = mdDoc ''
+ description = ''
Repository to add the runner to.
Changing this option triggers a new runner registration.
@@ -79,7 +79,7 @@ with lib;
tokenFile = mkOption {
type = types.path;
- description = mdDoc ''
+ description = ''
The full path to a file which contains either
* a fine-grained personal access token (PAT),
@@ -122,7 +122,7 @@ with lib;
name = mkOption {
type = types.nullOr types.str;
- description = mdDoc ''
+ description = ''
Name of the runner to configure. If null, defaults to the hostname.
Changing this option triggers a new runner registration.
@@ -133,7 +133,7 @@ with lib;
runnerGroup = mkOption {
type = types.nullOr types.str;
- description = mdDoc ''
+ description = ''
Name of the runner group to add this runner to (defaults to the default runner group).
Changing this option triggers a new runner registration.
@@ -143,7 +143,7 @@ with lib;
extraLabels = mkOption {
type = types.listOf types.str;
- description = mdDoc ''
+ description = ''
Extra labels in addition to the default (unless disabled through the `noDefaultLabels` option).
Changing this option triggers a new runner registration.
@@ -154,7 +154,7 @@ with lib;
noDefaultLabels = mkOption {
type = types.bool;
- description = mdDoc ''
+ description = ''
Disables adding the default labels. Also see the `extraLabels` option.
Changing this option triggers a new runner registration.
@@ -164,7 +164,7 @@ with lib;
replace = mkOption {
type = types.bool;
- description = mdDoc ''
+ description = ''
Replace any existing runner with the same name.
Without this flag, registering a new runner with the same name fails.
@@ -174,7 +174,7 @@ with lib;
extraPackages = mkOption {
type = types.listOf types.package;
- description = mdDoc ''
+ description = ''
Extra packages to add to `PATH` of the service to make them available to workflows.
'';
default = [ ];
@@ -182,7 +182,7 @@ with lib;
extraEnvironment = mkOption {
type = types.attrs;
- description = mdDoc ''
+ description = ''
Extra environment variables to set for the runner, as an attrset.
'';
example = {
@@ -193,7 +193,7 @@ with lib;
serviceOverrides = mkOption {
type = types.attrs;
- description = mdDoc ''
+ description = ''
Modify the service. Can be used to, e.g., adjust the sandboxing options.
'';
default = { };
@@ -203,7 +203,7 @@ with lib;
ephemeral = mkOption {
type = types.bool;
- description = mdDoc ''
+ description = ''
If enabled, causes the following behavior:
- Passes the `--ephemeral` flag to the runner configuration script
@@ -222,7 +222,7 @@ with lib;
user = mkOption {
type = types.nullOr types.str;
- description = mdDoc ''
+ description = ''
User under which to run the service.
If this option and the `group` option is set to `null`, nix-darwin creates
@@ -234,7 +234,7 @@ with lib;
group = mkOption {
type = types.nullOr types.str;
- description = mdDoc ''
+ description = ''
Group under which to run the service.
If this option and the `user` option is set to `null`, nix-darwin creates
@@ -246,7 +246,7 @@ with lib;
workDir = mkOption {
type = with types; nullOr str;
- description = mdDoc ''
+ description = ''
Working directory, available as `$GITHUB_WORKSPACE` during workflow runs
and used as a default for [repository checkouts](https://github.com/actions/checkout).
The service cleans this directory on every service start.
@@ -259,7 +259,7 @@ with lib;
nodeRuntimes = mkOption {
type = with types; nonEmptyListOf (enum [ "node20" ]);
default = [ "node20" ];
- description = mdDoc ''
+ description = ''
List of Node.js runtimes the runner should support.
'';
};