0c5eaeb doc(README.md): replace now-faulty examples with pointer to subplot — radicle-ci-broker

rad:zwTxygwuz5LDGBq255RA2CbNGrz8

Radicle CI broker

doc(README.md): replace now-faulty examples with pointer to subplot

Lars Wirzenius committed 1 year ago

commit 0c5eaeb8fa4d5a7b6b878b561a358f178a8a703f
parent 08bcf70

1 file changed +2 -46

modified README.md

@@ -85,52 +85,8 @@ following programs installed for the test suite:

 ## Configuration
 The configuration file is named on the command line. It is a YAML
 file, for example:
 ~~~yaml
 default_adapter: native
 db: ci-broker.sqlite
 adapters:
   native:
     command: radicle-native-ci
     env:
       RADICLE_NATIVE_CI: /home/liw/radicle/radicle-native-ci/x/config.yaml
     sensitive_env:
       some_secret: some_secret_value_that_is_not_logged
 filters:
   - !And
     - !Repository "rad:z2e6URdt1we1iG1BCVqtx8QVgsX4a"
     - !Or
       - !Branch "main"
       - !AnyPatchRef
 ~~~
 Or if you only want to filter for patch COB updates (e.g. comments),
 to the specified repository:
 ~~~yaml
 default_adapter: native
 db: ci-broker.sqlite
 adapters:
   native:
     command: radicle-native-ci
     env:
       RADICLE_NATIVE_CI: /home/liw/radicle/radicle-native-ci/x/config.yaml
     sensitive_env:
       some_secret: some_secret_value_that_is_not_logged
 filters:
   - !And
     - !Repository "rad:z2e6URdt1we1iG1BCVqtx8QVgsX4a"
     - !And
       - !AnyPatch
       - !Not
         - !AnyPatchRef
 ~~~
 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.
 file. See [`ci-broker.md`](ci-broker.md) for examples. Those examples
 are verified to work every time the test suite runs.
 ## Adapters