A tool to generate buildbot projects from a YAML file
Rusty-CI is meant to be a simple continuous integration tool that takes very little time to set up. Within 10 minutes of reading this README, you could have Rusty-CI testing your repository!
It works by constructing a webserver and several workers from one or two YAML files that describe how you want your project to be tested. When Rusty-CI detects a change in your repository, it will use the data from your YAML files to determine how you want that branch to be tested. Then, it will push a status report to your VCS.
You can find the usage documentation here, and the code documentation here.
``` $ rusty-ci
rusty_ci x.x.x Adam McDaniel adam.mcdaniel17@gmail.com A continuous integration tool written in Rust
USAGE: rusty-ci [SUBCOMMAND]
FLAGS: -h, --help Prints help information -V, --version Prints version information
SUBCOMMANDS: build Build rusty-ci from YAML file(s) help Prints this message or the help of the given subcommand(s) install Install buildbot rebuild Build and restart rusty-ci from input YAML file(s) setup Output a template YAML files for you to change to customize start Launch rusty-ci from an input YAML file stop Stop rusty-ci
To start a project, run the setup subcommand.
Be sure to follow the instructions after each subcommand very carefully!
```
This example Rusty-CI input YAML tests all branches and pull requests that begin with feature/ and that contain a change in files ending with .rs, .yaml, or .sh. It will only test pull requests from adam-mcdaniel or pull requests authorized by adam-mcdaniel commenting the phrase ok to test. These pass phrases can be used on a per test basis; so different phrases can authorize different tests.
```yaml requires: 0.9.0
master: title: "Rusty-CI" title-url: "https://github.com/adam-mcdaniel/rusty-ci" webserver-ip: localhost webserver-port: 8010 repo: "https://github.com/adam-mcdaniel/rusty-ci" poll-interval: 120
merge-request-handler: version-control-system: github owner: adam-mcdaniel repo-name: rusty-ci whitelist: - adam-mcdaniel
workers: test-worker: master-ip: localhost working-dir: 'test-worker'
schedulers: ci-change: builders: - rusty-ci-test branch: "feature/." triggers: - '..rs' - '..yaml' - '..sh' password: "ok to test"
builders: rusty-ci-test: script: - echo Hello world! - echo Im an instruction in a script! workers: - test-worker repo: "https://github.com/adam-mcdaniel/rusty-ci" ```
Install rust.
bash
curl https://sh.rustup.rs -sSf | sh
Install rusty-ci
bash
cargo install rusty-ci
Install python3, pip, and venv
sudo apt update
sudo apt upgrade
sudo apt install python3-dev python3-pip python3-venv
To start, run rusty-ci setup, and carefully read and follow the output's instructions.
I highly recommend using this in a linux-container to avoid poisoning your OS's environment. If you do decide to use a linux-container, be sure to apt update && apt upgrade, and apt install build-essential before doing anything though!
Just paste this stuff into your terminal to install and setup (I'm assuming you're using a Debian based OS).
```bash
apt update -y && apt upgrade -y apt install -y build-essential python3-dev python3-pip python3-venv
curl https://sh.rustup.rs -sSf | sh # Run the rust installer
source $HOME/.cargo/env # Add cargo to your path
cargo install -f rusty-ci # Install the latest rusty-ci release
rusty-ci setup template.yaml mail.yaml
rusty-ci install -q # Build install.sh chmod +x ./install.sh # Make install.sh executable ./install.sh # Install!
. venv/bin/activate # Enter the venv created by rusty-ci # to avoid poisoning your environment
echo "YOUR AUTH TOKEN HERE" > auth.token
rusty-ci build -q template.yaml --mail mail.yaml
rusty-ci start template.yaml -q
```
Rusty-CI is distributed under the terms of the Apache License (Version 2.0).
See LICENSE for details.