rusty-ci
A tool to generate buildbot projects from a YAML file
Description
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.
Features
- 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
Documentation
You can find the usage documentation here, and the code documentation here.
Example
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.
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"
Installation
Install rust.
|
Install rusty-ci
Install python3, pip, and venv
sudo apt update
sudo apt upgrade
sudo apt install python3-dev python3-pip python3-venv
Usage
To start, run rusty-ci setup
, and carefully read and follow the output's instructions.
Recommendations
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!
TL;DR
Just paste this stuff into your terminal to install and setup (I'm assuming you're using a Debian based OS).
# Update && Upgrade
&&
# Install rust
|
# Write template yaml files
# 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
# Enter venv
# to avoid poisoning your environment
# Add an authentication token from your VCS (github)
# Construct your ci bot
# Spin up the workers!
# All done!
License
Rusty-CI is distributed under the terms of the Apache License (Version 2.0).
See LICENSE for details.