The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Dist-Zilla-TravisCI-0.96
River stage one • 4 direct dependents • 6 total dependents
7 ++
/ Dist::Zilla::Plugin::TravisYML

NAME

Dist::Zilla::Plugin::TravisYML - creates a .travis.yml file for Travis CI

SYNOPSIS

    [TravisYML]
    ; defaults
    build_branch = /^build\/.*/
    notify_email = 1
    notify_irc   = 0
    mvdt         = 0
 
    ; These options are probably a good idea
    ; if you are going to use a build_branch
    [Git::CommitBuild]
    release_branch  = build/%b
    release_message = Release build of v%v (on %b)
 
    [@Git]
    allow_dirty = dist.ini
    allow_dirty = README
    allow_dirty = .travis.yml
    push_to = origin
    push_to = origin build/master:build/master

DESCRIPTION

This plugin creates a .travis.yml file in your distro for CI smoke testing (or what we like to call "[chain smoking|Dist::Zilla::App::Command::chainsmoke/CHAIN-SMOKING-]"). It will also (optionally) create a separate .travis.yml file for your build directory after a release.

Why two files? Because chain smoking via DZIL will work a lot differently than a traditional C<Makefile.PL; make>. This tests both your distribution repo environment as well as what a CPAN user would see.

Of course, you still need to turn on TravisCI and the remote still needs to be a GitHub repo for any of this to work.

OPTIONS

build_branch

This is a regular expression indicating which (build) branches are okay for running through Travis CI, per the configuration's branch whitelist option. The value will be inserted directly as an only clause. The default is /^build\/.*/.

This more or less requires Git::CommitBuild to work. (Ordering is important, too. TravisYML comes before Git::CommitBuild.) You should change this to match up with the release_branch option, if your build branch is not going to reside in a build/* structure.

Also, if you want to disable build branch testing, you can set this to 0.

notify_email

This affects the notification options of the resulting YML file. It can either be set to:

  • 0 = Disable email notification

  • 1 = Enable email notification, using Travis CI's default email scheme

  • foo@bar.com (can be multiple; one per line) = Enable email notification to these email addresses

The default is 1.

notify_irc

This affects the notification options of the resulting YML file. It can either be set to:

  • 0 = Disable IRC notification

  • 1 = Enable IRC notification, using the IRC or x_irc meta resource value

  • irc://irc.perl.org/#roomname (can be multiple; one per line) = Enable IRC notification to these IRC server/rooms

The default is 0. Please ask permission from the room channel operators before enabling bot notification.

mvdt

Turning this on enables Minimum Version Dependency Testing. This will make your YML file less of a static file, as it will now include commands to forcefully downgrade your dependencies to the lowest version that your prereqs said they would be able to use.

While going through the MVDT process is recommended, it can be a royal pain-in-the-ass sometimes, so this option isn't on by default. It's HIGHLY recommended that you read the above doc first to get an idea of what you're diving into.

This applies to both YML files.

AVAILABILITY

The project homepage is https://github.com/SineSwiper/Dist-Zilla-TravisCI/wiki.

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit http://www.perl.com/CPAN/ to find a CPAN site near you, or see https://metacpan.org/module/Dist::Zilla::TravisCI/.

AUTHOR

Brendan Byrd <BBYRD@CPAN.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2013 by Brendan Byrd.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)