Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yegor256/rultor
DevOps team assistant that helps you merge, deploy, and release GitHub-hosted apps and libraries
https://github.com/yegor256/rultor
chatbot continuous-delivery deployment devops docker docker-container java xml xsl
Last synced: 2 days ago
JSON representation
DevOps team assistant that helps you merge, deploy, and release GitHub-hosted apps and libraries
- Host: GitHub
- URL: https://github.com/yegor256/rultor
- Owner: yegor256
- License: other
- Created: 2013-02-18T15:39:50.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T23:45:10.000Z (4 months ago)
- Last Synced: 2024-05-29T02:44:47.663Z (4 months ago)
- Topics: chatbot, continuous-delivery, deployment, devops, docker, docker-container, java, xml, xsl
- Language: Java
- Homepage: https://www.rultor.com
- Size: 90.2 MB
- Stars: 555
- Watchers: 26
- Forks: 158
- Open Issues: 120
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://www.elegantobjects.org)
[](https://www.rultor.com/p/yegor256/rultor)
[](https://www.jetbrains.com/idea/)
[](https://github.com/yegor256/rultor/actions/workflows/mvn.yml)
[](https://codecov.io/gh/yegor256/rultor)
[](http://www.0pdd.com/p?name=yegor256/rultor)
[](https://codebeat.co/projects/github-com-yegor256-rultor)
[](https://www.codacy.com/gh/yegor256/rultor/dashboard?utm_source=github.com&utm_medium=referral&utm_content=yegor256/rultor&utm_campaign=Badge_Grade)
[](https://hitsofcode.com/view/github/yegor256/rultor)
[](https://www.sixnines.io/h/efd7)
[Rultor](https://www.rultor.com) 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 chat-bot interface. Just say `@rultor hello` in
any of your GitHub issue and the conversation will start.
Full documentation is at [doc.rultor.com](https://doc.rultor.com)
[Schema](rultor_schema.json) for .rultor.yml file
Need help online? Try our [Telegram group](https://t.me/zerocracy).
These blog posts may be helpful:
* [_Rultor, a Merging Bot_](http://www.yegor256.com/2014/07/24/rultor-automated-merging.html)
* [_Every Build in Its Own Docker Container_](http://www.yegor256.com/2014/07/29/docker-in-rultor.html)
* [_Master Branch Must Be Read-Only_](http://www.yegor256.com/2014/07/21/read-only-master-branch.html)
* [_Rultor + Travis_](http://www.yegor256.com/2014/07/31/travis-and-rultor.html)
Watch these videos to understand what Rultor is for:
* [_Deployment Scripts Are Dead; Meet Rultor_](https://www.youtube.com/watch?v=NflR7DKwxDY)
DevOps Pro; Vilnius, Lithuania; 26 May 2016
* [_A Practical Example of a One-Click Release_](https://www.youtube.com/watch?v=_61CuGhyv-o)
DevOpsPro 2016; Moscow, Russia; 15 November 2016
* [_Chat Bots Architecture_](https://www.youtube.com/watch?v=7yTIWFZrXpg)
GeekOUT 2016; Tallinn, Estonia; 9 June 2016
Default Docker image is [yegor256/rultor-image](https://hub.docker.com/r/yegor256/rultor-image/)
## 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](https://doc.rultor.com/basics.html)
in one of your GitHub pull requests, it does exactly this:
1. Reads the [.rultor.yml](https://doc.rultor.com/reference.html) 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](https://github.com/jcabi/jcabi-github/pull/878).
## How to Create a New Server
Rultor expects a server with [installed Docker](https://docs.docker.com/engine/install/ubuntu/)
to be available. It logins
there via SSH and starts Docker containers per each task. This is how you
configure a server from scratch (as `root` at Ubuntu 20.04):
```
$ apt-get install -y bc
$ groupadd docker
$ adduser rultor
$ gpasswd -a rultor docker
$ echo 'rultor ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers
$ mkdir /home/rultor/.ssh
$ cat > /home/rultor/.ssh/authorized_keys
$ chown rultor:rultor -R /home/rultor/.ssh
$ chmod 600 /home/rultor/.ssh/authorized_keys
```
Make sure the `b4.rultor.com` is pointing to the server. At the moment the hosted
app is working with a single server only, by this particular domain name.