forked from the-distro/ofborg
update readme to represent the more true rust bits
This commit is contained in:
parent
e92a8c95b5
commit
43dba9c53d
69
README.md
69
README.md
|
@ -92,39 +92,34 @@ Builds are run like:
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# arch
|
|
||||||
|
|
||||||
1. All github events go in to web/index.php, which sends the event to
|
|
||||||
an exchange named for the full name of the repo (ex: nixos/nixpkgs)
|
|
||||||
in lower case. The exchange is set to "fanout"
|
|
||||||
2. build-filter.php creates a queue called build-inputs and binds it
|
|
||||||
to the nixos/nixpkgs exchange. It also creates an exchange,
|
|
||||||
build-jobs, set to fan out. It listens for messages on the
|
|
||||||
build-inputs queue. Issue comments from authorized users on
|
|
||||||
PRs get tokenized and turned in to build instructions. These jobs
|
|
||||||
are then written to the build-jobs exchange.
|
|
||||||
3. builder.php creates a queue called `build-inputs-x86_64-linux`, and
|
|
||||||
binds it to the build-jobs exchange. It then listens for build
|
|
||||||
instructions on the `build-inputs-x86_64-linux` queue. For each
|
|
||||||
job, it uses nix-build to run the build instructions. The status
|
|
||||||
result (pass/fail) and the last ten lines of output are then placed
|
|
||||||
in to the `build-results` queue.
|
|
||||||
4. poster.php declares the build-results queue, and listens for
|
|
||||||
messages on it. It posts the build status and text output on the PR
|
|
||||||
the build is from.
|
|
||||||
|
|
||||||
|
|
||||||
## Getting Started
|
|
||||||
|
|
||||||
- you'll need to create the `WORKING_DIR`
|
# Running a builder
|
||||||
- nix-shell
|
|
||||||
- composer install
|
|
||||||
- php builder.php
|
|
||||||
|
|
||||||
The conspicuously missing config.php looks like:
|
```
|
||||||
|
nix-shell ./shell.nix
|
||||||
|
$ cd ofborg
|
||||||
|
$ cargo build
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
cargo build
|
||||||
|
```
|
||||||
|
|
||||||
|
then copy example.config.json to config.json and edit its vars. Set
|
||||||
|
`nix.remote` to an empty string if you're not using the daemon.
|
||||||
|
|
||||||
|
Run
|
||||||
|
|
||||||
|
```
|
||||||
|
./target/debug/builder ./config.json
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## old php stuff...
|
||||||
|
|
||||||
```php
|
```php
|
||||||
<?php
|
<?php
|
||||||
|
|
||||||
|
@ -162,25 +157,3 @@ function gh_client() {
|
||||||
}
|
}
|
||||||
*/
|
*/
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Getting started on the rust one...
|
|
||||||
|
|
||||||
```
|
|
||||||
nix-shell ./shell.nix -A rustEnv
|
|
||||||
$ cd ofborg
|
|
||||||
$ cargo build
|
|
||||||
```
|
|
||||||
|
|
||||||
```
|
|
||||||
cargo build
|
|
||||||
```
|
|
||||||
|
|
||||||
then copy example.config.json to config.json and edit its vars. Set
|
|
||||||
`nix.remote` to an empty string if you're not using the daemon.
|
|
||||||
|
|
||||||
Run
|
|
||||||
|
|
||||||
```
|
|
||||||
./target/debug/builder ./config.json
|
|
||||||
```
|
|
||||||
|
|
Loading…
Reference in a new issue