Intro doc?

[dhutty]

The oneliner description at https://rubygems.org/gems/leeroy_app is vague but still tempting to someone like me who is spending a lot of time working on improving CI/CD for a medium-large Engineering org.

But a 2 minute, even a 10 minute peek at the repo leaves me at: this needs more introductory documentation to tell me what this thing is, what problem it's going to solve or how it's going to make something I already do better/faster/stronger.

[hakamadare]

hello! this is a tool we developed for our own use, and we haven't quite polished it for easy adoption by others.

in brief: leeroy lets you define arbitrary tasks (provided you can implement them in Ruby) and then chain them together in a pipeline. it receives its configuration via environment variables, and has a mechanism for passing state from one task to another (e.g. a task that creates an EC2 instance inserts an instance_id key into the state, and then other tasks in the pipeline can read that key from the state).

[hakamadare]

you're absolutely right, though - we need better introductory documentation 😁

[pdurbin]

For what it's work, @dhutty and I just heard about https://github.com/edx/jenkins-configuration over at https://botbot.me/freenode/positivepython/msg/90397198/ . Perhaps the tools are complementary.

[pdurbin]

You might find https://github.com/LappleApple/feedmereadmes/blob/master/README-maturity-model.md interesting.