actions/runner
1
0
Fork 0
mirror of https://github.com/actions/runner.git synced 2025-12-13 10:05:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update --help (#282)

Browse Source 
* Update --help

* Tiny indent

* Remove once option
This commit is contained in:
David Kale
2020-01-17 13:55:11 -05:00
committed by GitHub
parent 1484c3fb03
commit 9cafe8c028
1 changed files with 28 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
src/Runner.Listener/Runner.cs
View File

@@ -451,16 +451,38 @@ namespace GitHub.Runner.Listener
ext = "sh"; ext = "sh";
#endif #endif
_term.WriteLine($@" _term.WriteLine($@"
Commands:, Commands:
.{separator}config.{ext} Configures the runner .{separator}config.{ext} Configures the runner
.{separator}config.{ext} remove Unconfigures the runner .{separator}config.{ext} remove Unconfigures the runner
.{separator}run.{ext} Runs the runner interactively. Does not require any options. .{separator}run.{ext} Runs the runner interactively. Does not require any options.
Options: Options:
--help Prints the help for each command
--version Prints the runner version --version Prints the runner version
--commit Prints the runner commit --commit Prints the runner commit
--help Prints the help for each command
"); Config Options:
--unattended Disable interactive prompts for missing arguments. Defaults will be used for missing options
--url string Repository to add the runner to. Required if unattended
--token string Registration token. Required if unattended
--name string Name of the runner to configure (default {Environment.MachineName ?? "myrunner"})
--work string Relative runner work directory (default {Constants.Path.WorkDirectory})
--replace Replace any existing runner with the same name (default false)");
#if OS_WINDOWS
_term.WriteLine($@" --runasservice Run the runner as a service");
_term.WriteLine($@" --windowslogonaccount string Account to run the service as. Requires runasservice");
_term.WriteLine($@" --windowslogonpassword string Password for the service account. Requires runasservice");
#endif
_term.WriteLine($@"
Examples:
Configure a runner non-interactively:
.{separator}config.{ext} --unattended --url <url> --token <token>
Configure a runner non-interactively, replacing any existing runner with the same name:
.{separator}config.{ext} --unattended --url <url> --token <token> --replace [--name <name>]");
#if OS_WINDOWS
_term.WriteLine($@" Configure a runner to run as a service:");
_term.WriteLine($@" .{separator}config.{ext} --url <url> --token <token> --runasservice");
#endif
} }
} }
} }