Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README should have what problems Rultor solves #998

Closed
wants to merge 3 commits into from
Closed

README should have what problems Rultor solves #998

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e8100e1
README should have what problems Rultor solves
Feb 4, 2016
fe65f9c
Updated README section according to feedback
Feb 4, 2016
22ff5cb
README should also mention pre-flight builds
Feb 4, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,22 @@ Default Docker image is [yegor256/rultor](https://registry.hub.docker.com/u/yego

TBD... _product statement_

## What Problem Does Rultor Solve?
## What Problems Does Rultor Solve?

TBD... _stakeholders and needs_
Automated deployment scripts have been around for some time. Rultor attempts to
tackle the problems those scripts do not.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mafagafogigante I don't think you described here these problems that are not tackled by build scripts. Or you meant Docker containers?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did describe them, although not explicitly.

  • If you run these scripts without a clean container, the number of external variables that may affect your build is much higher. Rultor manages the containers for you.
  • Rultor makes logs easily accessible, right where you called it. If you need CI logs, you usually have to go somewhere else to fetch them. Not to mention that they may be dropped after some time.
  • Rultor makes DevOps more human. Instead of invoking a script (that may not be a bash script, and a non-developer may have no clue about what to do), one can use plain English to instruct Rultor what to do. You program it only once (in .rultor.yml) and then it encapsulates what it is doing under the hood.

The paragraphs 2, 3, and 4 are essentially these points.


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.

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

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mafagafogigante that's true what you've written above, but what about entire idea of pre-flight builds? Please watch https://www.youtube.com/watch?v=6SfIc5ff-8U

## How Rultor Works?

Expand Down