/ 
Dist-Zilla-1.004
River stage three • 670 direct dependents • 727 total dependents
/ Dist::Zilla

NAME

Dist::Zilla - distribution builder; installer not included!

VERSION

version 1.004

DESCRIPTION

Dist::Zilla builds distributions of code to be uploaded to the CPAN. In this respect, it is like ExtUtils::MakeMaker, Module::Build, or Module::Install. Unlike those tools, however, it is not also a system for installing code that has been downloaded from the CPAN. Since it's only run by authors, and is meant to be run on a repository checkout rather than on published, released code, it can do much more than those tools, and is free to make much more ludicrous demands in terms of prerequisites.

For more information, see Dist::Zilla::Tutorial.

ATTRIBUTES

dzil_app

This attribute (which is optional) will provide the Dist::Zilla::App object if the Dist::Zilla object is being used in the context of the dzil command (or anything else using it through Dist::Zilla::App).

name

The name attribute (which is required) gives the name of the distribution to be built. This is usually the name of the distribution's main module, with the double colons (::) replaced with dashes. For example: Dist-Zilla.

version

This is the version of the distribution to be created.

abstract

This is a one-line summary of the distribution. If none is given, one will be looked for in the "main_module" of the dist.

main_module

This is the module where Dist::Zilla might look for various defaults, like the distribution abstract. By default, it's the shorted-named module in the distribution. This is likely to change!

This is the name of the legal entity who holds the copyright on this code. This is a required attribute with no default!

This is the year of copyright for the dist. By default, it's this year.

license

This is the Software::License object for this dist's license. It will be created automatically, if possible, with the copyright_holder and copyright_year attributes. If necessary, it will try to guess the license from the POD of the dist's main module.

A better option is to set the license name in the dist's config to something understandable, like Perl_5.

authors

This is an arrayref of author strings, like this:

[
  'Ricardo Signes <rjbs@cpan.org>',
  'X. Ample, Jr <example@example.biz>',
]

This is likely to change at some point in the near future.

files

This is an arrayref of objects implementing Dist::Zilla::Role::File that will, if left in this arrayref, be built into the dist.

root

This is the root directory of the dist, as a Path::Class::Dir. It will nearly always be the current working directory in which dzil was run.

plugins

This is an arrayref of plugins that have been plugged into this Dist::Zilla object.

built_in

This is the Path::Class::Dir, if any, in which the dist has been built.

prereq

This is a hashref of module prerequisites. This attribute is likely to get greatly overhauled, or possibly replaced with a method based on other (private?) attributes.

METHODS

from_config

my $zilla = Dist::Zilla->from_config(\%arg);

This routine returns a new Zilla from the configuration in the current working directory.

Valid arguments are:

config_class - the class to use to read the config
               default: Dist::Zilla::Config::INI

plugins_with

my $roles = $zilla->plugins_with( -SomeRole );

This method returns an arrayref containing all the Dist::Zilla object's plugins that perform a the named role. If the given role name begins with a dash, the dash is replaced with "Dist::Zilla::Role::"

build_in

$zilla->build_in($root);

This method builds the distribution in the given directory. If no directory name is given, it defaults to DistName-Version. If the distribution has already been built, an exception will be thrown.

ensure_built_in

$zilla->ensure_built_in($root);

This method behaves like "build_in", but if the dist is already built in $root (or the default root, if no root is given), no exception is raised.

build_archive

$dist->build_archive($root);

This method will ensure that the dist has been built in the given root, and will then build a tarball of that directory in the current directory.

test

$zilla->test;

This method builds a new copy of the distribution and tests it. If the tests appear to pass, it returns true. If something goes wrong, it returns false.

release

$zilla->release;

This method releases the distribution, probably by uploading it to the CPAN. The actual effects of this method (as with most of the methods) is determined by the loaded plugins.

log

$zilla->log($message);

This method logs the given message. In the future it will be a more useful and expressive method. For now, it just prints the string after tacking on a newline.

AUTHOR

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2009 by Ricardo SIGNES.

This is free software; you can redistribute it and/or modify it under the same terms as perl itself.