Carrasco

Heartless and easy script execution

Installation

Add this line to your application's Gemfile:

gem 'carrasco'

And then execute:

$ bundle

Or install it yourself as:

$ gem install carrasco

Usage

Given you have a config file like the following in the root of your project:

# .carrasco.yml

commands:

  test:
    description: execute ruby tests
    command: rake test

  phpunit:
    description: execute php tests
    command: ./bin/vendor/phpunit --configuration=tests/phpunit.xml

  clear_cache:
    description: Clears the application cache
    command: rm -rf ./app/cache

# to be implemented
groups:
  qa:
    description: Runs qa tools
    # if you want phpunit to run even if the test task fails
    # defaults to true
    break_on_failure: false
    commands:
      - test
      - phpunit

You can execute:

bundle exec carrasco         # list commands
bundle exec carrasco all     # all your tasks
bundle exec carrasco phpunit # phpunit only
bundle exec carrasco qa      # all qa scripts

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mgjacobus/carrasco. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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