Radish alpha
r
radicle-ci-broker
rad:zwTxygwuz5LDGBq255RA2CbNGrz8
Radicle CI broker
Radicle
Git
Patches › e73c834e
chore: build and optionally publish documentation
Merged liw opened 1 year ago

Signed-off-by: Lars Wirzenius liw@liw.fi

Activity Changes +24 -1
3 files changed +24 -1 5a5e2af1 → 8809b09c
modified .radicle/native.yaml
@@ -7,3 +7,5 @@ shell: |
  cargo build --all-targets --workspace

  cargo doc --workspace

  cargo test --workspace --no-fail-fast
+
+ 
  make -C doc publish
modified README.md
@@ -8,6 +8,7 @@ This is not quite 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. Quick summary:
@@ -19,7 +20,15 @@ own adapter.


To build the documentation, run `make` in the `doc` directory. You'll

need some tools installed: Pandoc, graphviz (dot), PlantUML,
- 
pikchr-cli.
+ 
pikchr-cli. The others are widely packaged, pikchr-cli is a Rust
+ 
crate, so you can install it with `cargo install pikchr-cli`
+
+ 
Build and publish the documentation like this:
+
+ 
~~~
+ 
RADICLE_CI_BROKER_WEBROOT=/tmp/ci make -C doc publish
+ 
~~~
+ 




## Binaries
@@ -36,12 +45,14 @@ The crate contains several binaries:
* `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:
@@ -52,6 +63,7 @@ cargo test


(The usual way, for a Rust program.)
+ 


## Configuration



The configuration file is named on the command line. It is a YAML
@@ -101,6 +113,7 @@ 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.
+ 


## License



Radicle CI broker is distributed under the terms of both the MIT
modified doc/Makefile
@@ -16,4 +16,12 @@


all: architecture.html
+ 
publish: all
+ 
	if [ "$(git branch --show-current)" = main ]; then \
+ 
	    if [ "${RADICLE_CI_BROKER_WEBROOT:-unset}" != unset ]; then \
+ 
		    install -d -m 0755 "$(RADICLE_CI_BROKER_WEBROOT)"; \
+ 
		    install -m 0644 *.html "$(RADICLE_CI_BROKER_WEBROOT)"; \
+ 
	    fi; \
+ 
	fi
+ 


architecture.html: architecture.svg architecture-ext.svg comp.svg comp-ext.svg Makefile