c3179f2 docs(README.md): document rad-ci --help option, show all options — radicle-native-ci

Radicle CI adapter for native CI

docs(README.md): document rad-ci --help option, show all options

Lars Wirzenius committed 1 year ago

commit c3179f2a6c84faf38da603632309dd86720e7861
parent 5e4b69289512df445641bd2eee38d4a5ef56bab1

1 file changed +21 -2

modified README.md

@@ -33,8 +33,27 @@ rad ci

 This will read `.radicle/native.yaml` and run the shell commands
 specified there.
 (No command line arguments or options needed, nor any environment
 variables for this.)
 Toe see `rad-ci` options, run it with the `--help` option:
 ~~~sh
 $ rad-ci -- --help
 Run the commands the Radicle native CI adapter would run for this repository.
 The shell commands are specified in the .radicle/native.yaml file, in the shell field. They are run
 directly on the host, using the Bash shell, without any isolation.
 Usage: rad-ci [OPTIONS]
 Options:
       --dry-run
           Don't actually run anything, merely output what would be given to Bash to run
   -h, --help
           Print help (see a summary with '-h')
   -V, --version
           Print version
 ~~~
 ## Architecture