RakeAnnouncer

A small gem to enhance existing rake tasks by printing a brief message before each one is invoked. The list of tasks to wrap/enhance is configurable. Also included is a task to print a simple and colourful "All Tests Passed" message.

This gem was inspired by Rake-n-Bake.

Install the gem and add to the application's Gemfile by executing:

bundle add rake_announcer

If bundler is not being used to manage dependencies, install the gem by executing:

gem install rake_announcer

Add the following to your Rakefile:

require "rake_announcer/rake_task"
RakeAnnouncer::RakeTask.new(tasks: %i[spec rubocop])

Include the names of any rake tasks that you want announced in the tasks array. The above example will print a message before the spec and rubocop tasks.

You can also print a simple "All Tests Passed" message by adding the rake_announcer:ok task, e.g.:

task default: %i[spec rubocop rake_announcer:ok]

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

To release a new version, run bundle exec rake semver:XXX (replacing XXX with major or minor or patch), which will bump the version number and create a git tag for the version. Then run git push origin main --tags to push the new tag.

Then run bundle exec rake release, which will build and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/ukdave/rake_announcer.

The gem is available as open source under the terms of the MIT License.