Bake is a task execution tool, inspired by Rake, but codifying many of the use cases which are typically implemented in an ad-hoc manner.
Features
Rake is an awesome tool and loved by the community. So, why reinvent it? Bake provides the following features that Rake does not:
- On demand loading of files following a standard convention. This avoid loading all your rake tasks just to execute a single command.
- Better argument handling including support for positional and optional arguments.
- Focused on task execution not dependency resolution. Implementation is simpler and a bit more predictable.
- Canonical structure for integration with gems.
That being said, Rake and Bake can exist side by side in the same project.
Usage
Please browse the source code index or refer to the guides below.
Getting Started
This guide gives a general overview of bake
and how to use it.
Command Line Interface
The bake
command is broken up into two main functions: list
and call
.
Project Integration
This guide explains how to add bake
to a Ruby project.
Gem Integration
This guide explains how to add bake
to a Ruby gem and export standardised tasks for use by other gems and projects.
Input and Output
bake
has built in tasks for reading input and writing output in different formats. While this can be useful for general processing, there are some limitations, notably that rich object representations like json
and yaml
often don't support stream processing.
Contributing
We welcome contributions to this project.
- Fork it.
- Create your feature branch (
git checkout -b my-new-feature
). - Commit your changes (
git commit -am 'Add some feature'
). - Push to the branch (
git push origin my-new-feature
). - Create new Pull Request.
Developer Certificate of Origin
This project uses the Developer Certificate of Origin. All contributors to this project must agree to this document to have their contributions accepted.
Contributor Covenant
This project is governed by the Contributor Covenant. All contributors and participants agree to abide by its terms.
See Also
- Bake::Gem — Release and install gems using
bake
. - Bake::Modernize — Modernize gems consistently using
bake
. - Console — A logging framework which integrates with
bake
. - Variant — A framework for selecting different environments, including
bake
tasks. - Utopia — A website framework which uses
bake
for maintenance tasks.