Update --help

[dakale]

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]

@lucascosti 👀

[TingluoHuang]

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.

[dakale]

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

[bryanmacfarlane]

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]

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]

#226