Class Index [+]

Quicksearch

RAKE – Ruby Make

home

github.com/ruby/rake

bugs

github.com/ruby/rake/issues

docs

ruby.github.io/rake

Description

Rake is a Make-like program implemented in Ruby. Tasks and dependencies are specified in standard Ruby syntax.

Rake has the following features:

Installation

Gem Installation

Download and install rake with the following.

gem install rake

Usage

Simple Example

First, you must write a “Rakefile” file which contains the build rules. Here's a simple example:

task default: %w[test]

task :test do
  ruby "test/unittest.rb"
end

This Rakefile has two tasks:

Running the “rake” command without any options will cause it to run the “default” task in the Rakefile:

% ls
Rakefile     test/
% rake
(in /home/some_user/Projects/rake)
ruby test/unittest.rb
....unit test output here...

Type “rake –help” for all available options.

Resources

Rake Information

Presentations and Articles about Rake

Other Make Re-envisionings …

Rake is a late entry in the make replacement field. Here are links to other projects with similar (and not so similar) goals.

Credits

Jim Weirich

Who originally created Rake.

Ryan Dlugosz

For the initial conversation that sparked Rake.

Nobuyoshi Nakada <nobu@ruby-lang.org>

For the initial patch for rule support.

Tilman Sauerbeck <tilman@code-monkey.de>

For the recursive rule patch.

Eric Hodel

For aid in maintaining rake.

Hiroshi SHIBATA

Maintainer of Rake 10.X and Rake 11.X

License

Rake is available under an MIT-style license.

Copyright © Jim Weirich

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


Other stuff

Author

Jim Weirich <jim.weirich@gmail.com>

Requires

Ruby 2.0.0 or later

License

Copyright Jim Weirich. Released under an MIT-style license. See the MIT-LICENSE file included in the distribution.

Warranty

This software is provided “as is” and without any express or implied warranties, including, without limitation, the implied warranties of merchantability and fitness for a particular purpose.

Historical

Rake was originally created by Jim Weirich, who unfortunately passed away in February 2014. This repository was originally hosted at github.com/jimweirich/rake, however with his passing, has been moved to ruby/rake.

You can view Jim's last commit here: github.com/jimweirich/rake/tree/336559f28f55bce418e2ebcc0a57548dcbac4025

You can read more about Jim at Wikipedia.

Thank you for this great tool, Jim. We'll remember you.