Radish alpha
r
Radicle CI broker
Radicle
Git (anonymous pull)
Log in to clone via SSH
docs: explain about the config file and filters in README
Lars Wirzenius committed 2 years ago
commit 77860a8c288fd7255ff68828810ab3c9122f38d8
parent b2862d22907806ff4f653e76079b1960b5a5fd41
1 file changed +24 -0
modified README.md
@@ -3,3 +3,27 @@
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.
+

+
## Configuration
+

+
The configuration file is named on the command line. It is a YAML
+
file, for example:
+

+
~~~yaml
+
default_adapter: native
+
adapters:
+
  native:
+
    command: radicle-native-ci
+
    env:
+
      RADICLE_NATIVE_CI: /home/liw/radicle/radicle-native-ci/x/config.yaml
+
filters:
+
  - !And
+
    - !Repository "rad:z2e6URdt1we1iG1BCVqtx8QVgsX4a"
+
    - !Or
+
      - !Branch "main"
+
      - !AnyPatch
+
~~~
+

+
This runs the native CI engine as an adapter, on any repository events
+
that pass the filter. The filter allows any changes to the `main`
+
branch or any Radicle patch, on the specified repository.