Radish alpha
r
Radicle CI broker
Radicle
Git (anonymous pull)
Log in to clone via SSH
docs(README.md): update
Lars Wirzenius committed 2 years ago
commit 706d92b9c2f4c675237ec9e083f1106df24e1a3d
parent 30c7d59e686514e2ad7e76c38af16604abc3289d
1 file changed +34 -0
modified README.md
@@ -4,6 +4,40 @@ This is not production ready code yet, but it will eventually become a
thing that listens for changes in a Radicle node, and triggers CI on
the relevant ones.

+
## Architecture
+

+
See the `doc` directory for architecture documentation.
+

+
## Binaries
+

+
The crate contains several binaries:
+

+
* `ci-broker` --- the actual CI broker
+
  - this is probably the only one you need to care about
+
* `broker-messages`  --- helper program to print sample messages
+
  between the broker and adapters
+
* `filter-events` --- a helper program to see what events a CI broker
+
  config allows
+
* `list_runs` --- list all CI runs in a broker database
+
* `pagegen` -- helper program to produce sample report pages
+
  - mostly only useful for testing changes to the page generating code
+

+
## Packaging
+

+
There is simple, simplistic, rudimentary, personal-use-only packaging
+
for Debian in the `debian` directory, used by Lars to build packages
+
for his own use.
+

+
## Running tests
+

+
To run the test suite for the CI broker:
+

+
~~~sh
+
cargo test
+
~~~
+

+
(As usual, for a Rust program.)
+

## Configuration

The configuration file is named on the command line. It is a YAML