47 releases (8 breaking)
|0.9.6||Aug 16, 2019|
|0.8.5||Aug 9, 2019|
|0.6.5||Jul 30, 2019|
#141 in Testing
230 downloads per month
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.
- Webgui for detailed test output and CI configuration
- Detecting merge / pull requests on GitHub and GitLab
- Use regular expressions to trigger tests for specific file changes on specific branches
- Tests that can depend on one another
- Custom testing scripts
- Customizable email bot settings
$ rusty-ci rusty_ci x.x.x Adam McDaniel <email@example.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
.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.
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"
curl https://sh.rustup.rs -sSf | sh
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).
# Update && Upgrade apt update -y && apt upgrade -y apt install -y build-essential python3-dev python3-pip python3-venv # Install rust 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 # Write template yaml files rusty-ci setup template.yaml mail.yaml # Uncomment to modify your CI's settings to fit your project # nano template.yaml # Controls how your CI tests your code # nano mail.yaml # Defines email update / notification settings # Install rusty-ci dependencies rusty-ci install -q # Build install.sh chmod +x ./install.sh # Make install.sh executable ./install.sh # Install! # Enter venv . venv/bin/activate # Enter the venv created by rusty-ci # to avoid poisoning your environment # Add an authentication token from your VCS (github) echo "YOUR AUTH TOKEN HERE" > auth.token # Construct your ci bot rusty-ci build -q template.yaml --mail mail.yaml # Spin up the workers! rusty-ci start template.yaml -q # All done!
- Right now,
cargo tarpaulin --exclude-files src/bin.rsshows that we only test 27.53% of our code. There needs to be more tests, and more cases for those tests.
- The docs, as far as I remember, are not up to date with the current version of Rusty-CI. I've tried to make them generally version agnostic, but of course several features and bugs have been added and fixed since the last time I documented Rusty-CI.
- There needs to be more stability and more security. I think these aspects can only be improved by using Rusty-CI and noticing its quirks.
Rusty-CI is distributed under the terms of the Apache License (Version 2.0).
See LICENSE for details.