Skip to content

krzyk/rultor

 
 

Repository files navigation

Donate via Zerocracy

EO principles respected here Managed by Zerocracy DevOps By Rultor.com We recommend IntelliJ IDEA

Availability at SixNines Coverage Status PDD status codebeat badge Codacy Badge Dependencies Join the chat at https://gitter.im/yegor256/rultor Conference recommends

Full documentation is at doc.rultor.com

These blog posts may be helpful: Every Build in Its Own Docker Container, Master Branch Must Be Read-Only, Rultor + Travis, and Rultor, a Merging Bot.

Default Docker image is yegor256/rultor

What Is Rultor?

Rultor is a DevOps team assistant. It helps your programmers and release managers automate routine operations (merge, deploy and release), with an easy-to-use intuitive interface.

What Problems Does Rultor Solve?

Automated deployment scripts have been around for some time. Rultor attempts to tackle the problems those scripts do not.

The first benefit of Rultor is that it gives you isolation of your deployment script in its own virtual environment by using Docker containers. This substantially reduces the amount of external state that could affect your build and makes errors more easily reproducible.

Additionally, because of the way Rultor integrates with modern issue trackers, all the logs are stored and published to the ticket on which Rultor was mentioned. Making vital information easily accessible to all developers.

Rultor performs pre-flight builds. Instead of merging into master and then seeing if your changes broke the build or not, Rultor checks out the master branch, apply your changes to it, then runs everything it was set up to run. If, and only if, everything goes well, Rultor merges the changes into master. This programmatically prevents the master from being broken by developers. Not having to worry about breaking the build for everyone else has a very positive impact in the way developers write code, increasing their productivity and mitigating their fear of making mistakes.

Lastly, Rultor provides an integrated and humanized interface to DevOps tools, as a human-readable sentence suffices to trigger a merge or a release.

How Rultor Works?

Once Rultor finds a merge command in one of your GitHub pull requests, it does exactly this:

  1. Reads the .rultor.yml YAML configuration file from the root directory of your repository.
  2. Gets automated build execution command from it, for example bundle test.
  3. Checks out your repository into a temporary directory on one of its servers.
  4. Merges pull request into master branch.
  5. Starts a new Docker container and runs the build execution command in it, for example bundle test.
  6. If everything is fine, pushes modified master branch to GitHub.
  7. Reports back to you, in the GitHub pull request.

You can see it in action, for example, in this pull request: jcabi/jcabi-github#878.

What Is Rultor SLA?

TBD... quality requirements

How to Contribute

If you are interested in contributing please refer to CONTRIBUTING.md

Docker server

The server where Docker works must be Ubuntu 16.04.

Install Docker.

Create rultor user and add it to docker group.

Add rultor to sudoers.

apt-get update -y
apt-get install -y mailx
apt-get install -y gnupg2
apt-get install -y bc

Got questions?

If you have questions or general suggestions, don't hesitate to submit a new Github issue.

Continuous Integration

We're using all possible continuous integration systems, mostly for fun :) Here is our selection criteria.

travis-ci.org
Build Status

shippable.com
Build Status

appveyor.com
Build status

wercker.com
wercker status

Less interesting and/or stable stuff:

codeship.io
Codeship Status for yegor256/rultor

circleci.io
Circle CI

semaphoreapp.com
Build Status

solanolabs.com
sonolabs status

About

Programmable Enforcer of a Software Development Process

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 92.1%
  • XSLT 4.3%
  • Shell 0.8%
  • CSS 0.8%
  • Dockerfile 0.7%
  • HTML 0.7%
  • Other 0.6%