From: Frank Duncan Date: Sat, 18 Dec 2021 22:26:53 +0000 (-0600) Subject: Update documentation a little X-Git-Url: https://code.consxy.com/gitweb/gitweb.cgi?p=candle;a=commitdiff_plain;h=ec3c4dac8416e025e186501842723852b16cab4e Update documentation a little --- diff --git a/README.md b/README.md index cb78e45..14a6262 100644 --- a/README.md +++ b/README.md @@ -27,30 +27,15 @@ Only one can be running at a time. = Usage = * Run bin/candle-server on a server somewhere, so that the candle client can connect to it -* Add projects via `bin/candle project --add`, see `--help` for more information -* Remove projects via `bin/candle project --delete`, see `--help` for more information -* Run `bin/candle project --show ` to show status of project +* Add projects via `bin/candle project add`, see `--help` for more information +* Remove projects via `bin/candle project delete`, see `--help` for more information +* Run `bin/candle project show ` to show status of project * Includes what branches are failing -* Run `bin/candle project --list` to show list all projects, and status -* Run `bin/candle job --log :` to see log +* Run `bin/candle project list` to show list all projects, and status +* Run `bin/candle project refresh` to refresh a project +* Run `bin/candle job log :` to see log +* Run `bin/candle job retry :` to retry the job == Local == * Run `bin/candle run` from a candle enabled project - -= General Design = - -For all projects added, a watcher thread runs `git fetch origin` to see if there's any -new SHAs for which jobs need to be run. - -When a previously unknown SHA shows up in the git directory, a job is created for that -SHA, which then clones the repository into the right place and runs `candle` for that location, -if there's a .candle file. - -A project is failing if any branches are failing, that is to say that the current sha -for that branch is failing. - -== Edge Cases == - -* For SHAs that hang, or get into infinite loops, there's a timeout before the server is killed - and marked as failure.