Update --help #282

dakale · 2020-01-14T20:40:39Z

Updates --help document to separate out common/config/run options that are exposed by these helper scripts

Separates options that are only useful on Windows (for running as service)

Omits internal binary flags that arent a public api, monitorsocketaddress and startuptype.
Omits auth because I think only one auth type is supported right now.
Omits username and pool which seem to be unused.

Provides basic examples for common scenarios (unattended, scripted setup)

Windows/Unix:

Commands:
 .\config.cmd         Configures the runner
 .\config.cmd remove  Unconfigures the runner
 .\run.cmd            Runs the runner interactively. Does not require any options.

Options:
 --help     Prints the help for each command
 --version  Prints the runner version
 --commit   Prints the runner commit

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 DAKALE-WORK)
 --work string    Relative runner work directory (default _work)
 --replace        Replace any existing runner with the same name (default false)
 --runasservice   Run the runner as a service
 --windowslogonaccount string   Account to run the service as. Requires runasservice
 --windowslogonpassword string  Password for the service account. Requires runasservice

Run Options:
 --once  Exit after completing a job. Does not remove the runner

Examples:
 Configure a runner non-interactively:
  .\config.cmd --unattended --url <url> --token <token>
 Configure a runner non-interactively, replacing any existing runner with the same name:
  .\config.cmd --unattended --url <url> --token <token> --replace [--name <name>]
 Configure a runner to run as a service:
  .\config.cmd --url <url> --token <token> --runasservice

--------------------------------------------------------------------------------------------------------------------

Commands:
 ./config.sh         Configures the runner
 ./config.sh remove  Unconfigures the runner
 ./run.sh            Runs the runner interactively. Does not require any options.

Options:
 --help     Prints the help for each command
 --version  Prints the runner version
 --commit   Prints the runner commit

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 DAKALE-WORK)
 --work string    Relative runner work directory (default _work)
 --replace        Replace any existing runner with the same name (default false)

Run Options:
 --once  Exit after completing a job. Does not remove the runner

Examples:
 Configure a runner non-interactively:
  ./config.sh --unattended --url <url> --token <token>
 Configure a runner non-interactively, replacing any existing runner with the same name:
  ./config.sh --unattended --url <url> --token <token> --replace [--name <name>]

thejoebourneidentity · 2020-01-14T21:08:39Z

@lucascosti 👀

TingluoHuang · 2020-01-15T15:36:15Z

src/Runner.Listener/Runner.cs

+    _term.WriteLine($@" --windowslogonpassword string  Password for the service account. Requires runasservice");
+#endif
+    _term.WriteLine($@"
+Run Options:


I would suggest taking the --once option out, since run once is not fully working due to race condition on the server-side.
@bryanmacfarlane for input.

Removed it for now. It can easily be added back when we are ready to release/support it

If we add it back, it would likely be something like --ephemeral. keep it gone for now. we should also delete the code supporting once in a separate PR since it was the wrong pattern

bryanmacfarlane · 2020-01-17T03:16:02Z

LGTM

lucascosti

@lucascosti 👀

This is a great update! I think this will prevent a lot of users from having to resort to the documentation if they are have started using self-hosted runners without any previous assistance.

I don't think any docs update is required for this, but let me know if you disagree 🙂

TingluoHuang · 2020-01-19T15:34:24Z

#226

* Update --help * Tiny indent * Remove once option

David Kale added 2 commits January 14, 2020 15:37

Update --help

1277213

Tiny indent

ca86e72

TingluoHuang reviewed Jan 15, 2020

View reviewed changes

Remove once option

b88fa7e

bryanmacfarlane approved these changes Jan 17, 2020

View reviewed changes

lucascosti approved these changes Jan 17, 2020

View reviewed changes

dakale merged commit 9cafe8c into master Jan 17, 2020

dakale deleted the 226-help branch January 17, 2020 18:55

AdamOlech pushed a commit to antmicro/runner that referenced this pull request Jan 28, 2021

Update --help (actions#282)

2b2d4c7

* Update --help * Tiny indent * Remove once option

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update --help #282

Update --help #282

dakale commented Jan 14, 2020 •

edited

Loading

thejoebourneidentity commented Jan 14, 2020

TingluoHuang Jan 15, 2020

dakale Jan 16, 2020

bryanmacfarlane Jan 17, 2020

bryanmacfarlane commented Jan 17, 2020

lucascosti left a comment

TingluoHuang commented Jan 19, 2020

Update --help #282

Update --help #282

Conversation

dakale commented Jan 14, 2020 • edited Loading

thejoebourneidentity commented Jan 14, 2020

TingluoHuang Jan 15, 2020

Choose a reason for hiding this comment

dakale Jan 16, 2020

Choose a reason for hiding this comment

bryanmacfarlane Jan 17, 2020

Choose a reason for hiding this comment

bryanmacfarlane commented Jan 17, 2020

lucascosti left a comment

Choose a reason for hiding this comment

TingluoHuang commented Jan 19, 2020

dakale commented Jan 14, 2020 •

edited

Loading