1Dist::Zilla::Dist::BuilUdseerr(3C)ontributed Perl DocumeDnitsatt:i:oZnilla::Dist::Builder(3)
2
3
4

NAME

6       Dist::Zilla::Dist::Builder - dist zilla subclass for building dists
7

VERSION

9       version 4.300002
10

ATTRIBUTES

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

METHODS

16   from_config
17         my $zilla = Dist::Zilla->from_config(\%arg);
18
19       This routine returns a new Zilla from the configuration in the current
20       working directory.
21
22       This method should not be relied upon, yet.  Its semantics are certain
23       to change.
24
25       Valid arguments are:
26
27         config_class - the class to use to read the config
28                        default: Dist::Zilla::MVP::Reader::Finder
29
30   build_in
31         $zilla->build_in($root);
32
33       This method builds the distribution in the given directory.  If no
34       directory name is given, it defaults to DistName-Version.  If the
35       distribution has already been built, an exception will be thrown.
36
37   build
38       This method just calls "build_in" with no arguments.  It gets you the
39       default behavior without the weird-looking formulation of "build_in"
40       with no object for the preposition!
41
42   ensure_built_in
43         $zilla->ensure_built_in($root);
44
45       This method behaves like "build_in", but if the dist is already built
46       in $root (or the default root, if no root is given), no exception is
47       raised.
48
49   ensure_built_in
50       This method just calls "ensure_built_in" with no arguments.  It gets
51       you the default behavior without the weird-looking formulation of
52       "ensure_built_in" with no object for the preposition!
53
54   build_archive
55         $zilla->build_archive;
56
57       This method will ensure that the dist has been built, and will then
58       build a tarball of the build directory in the current directory.
59
60   release
61         $zilla->release;
62
63       This method releases the distribution, probably by uploading it to the
64       CPAN.  The actual effects of this method (as with most of the methods)
65       is determined by the loaded plugins.
66
67   clean
68       This method removes temporary files and directories suspected to have
69       been produced by the Dist::Zilla build process.  Specifically, it
70       deletes the .build directory and any entity that starts with the dist
71       name and a hyphen, like matching the glob "Your-Dist-*".
72
73   install
74         $zilla->install( \%arg );
75
76       This method installs the distribution locally.  The distribution will
77       be built in a temporary subdirectory, then the process will change
78       directory to that subdir and an installer will be run.
79
80       Valid arguments are:
81
82         install_command - the command to run in the subdir to install the dist
83                           default (roughly): $^X -MCPAN -einstall .
84
85                           this argument should be an arrayref
86
87   test
88         $zilla->test;
89
90       This method builds a new copy of the distribution and tests it using
91       "run_tests_in".
92
93   run_tests_in
94         my $error = $zilla->run_tests_in($directory);
95
96       This method runs the tests in $directory (a Path::Class::Dir), which
97       must contain an already-built copy of the distribution.  It will throw
98       an exception if there are test failures.
99
100       It does not set any of the *_TESTING environment variables, nor does it
101       clean up $directory afterwards.
102
103   run_in_build
104         $zilla->run_in_build( \@cmd );
105
106       This method makes a temporary directory, builds the distribution there,
107       executes the dist's first BuildRunner, and then runs the given command
108       in the build directory.  If the command exits non-zero, the directory
109       will be left in place.
110

AUTHOR

112       Ricardo SIGNES <rjbs@cpan.org>
113

115       This software is copyright (c) 2011 by Ricardo SIGNES.
116
117       This is free software; you can redistribute it and/or modify it under
118       the same terms as the Perl 5 programming language system itself.
119
120
121
122perl v5.12.4                      2011-09-22     Dist::Zilla::Dist::Builder(3)
Impressum