- GitHub - drbrain/hoe-travis: A Hoe plugin that allows your gem to gain maximum benefit from http://travis-ci.org
- hoe-travis-1.1 Documentation
hoe-travis is a Hoe plugin that allows your gem to gain maximum benefit
from
http://travis-ci.org. The plugin contains a .travis.yml generator and a
pre-defined rake task which runs the tests and ensures your manifest
file is correct.
With hoe-travis it is easy to add additional checks. Custom checks can
be
easily verified locally by simply running a rake task instead of
committing
and pushing a change, waiting for travis to run your tests, then trying
a new
commit if you didn’t fix the problem.
=== Features
- .travis.yml generation task
- Pre-defined rake tasks which are run by travis-ci
- Easy to hook up rake tasks for additional travis-ci setup or checks
=== Getting Started
If you’re not already using Hoe with your project, see:
To get started with hoe-travis, first install it:
sudo gem install hoe-travis
Then add hoe-travis as a plugin to your Rakefile:
Hoe.plugin :travis
Then generate a .travis.yml
$ rake travis:generate
This will bring up your EDITOR with your travis.yml for any desired
tweaks.
Save the file when you’re done, then check in your .travis.yml. For
further
details of how the configuration is generated see
module Hoe::Travis - hoe-travis-1.1 Documentation and
module Hoe::Travis - hoe-travis-1.1 Documentation.
(If you don’t have the EDITOR environment variable set to your favorite
editor, please do so. Note that some editors may need extra flags to
wait for
files to be edited. For MacVIM, export EDITOR="mvim --remote-wait"
will wait for the file to be closed before returning.)
If you would like to make future changes to your .travis.yml you can
run:
$ rake travis:edit
Which, like rake travis:generate
, will bring up your EDITOR with your
.travis.yml. When you’ve saved the file the changes will be checked by
travis-lint before writing back to .travis.yml and give you a chance to
correct them.
If you’ve edited your .travis.yml by hand you can run:
$ rake travis:check
to check it.
Testing your travis-ci setup is easy with hoe-travis. You can run:
$ rake travis
to run the same checks travis-ci will. By default this includes running
the
tests and ensuring the Manifest.txt file is complete. There is also the
before script:
$ rake travis:before
Which will run the setup tasks needed for your project.
You can also enable and disable travis-ci using rake travis:enable
and rake travis:disable
. See
module Hoe::Travis - hoe-travis-1.1 Documentation for
details.