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 6.017
10

ATTRIBUTES

12   built_in
13       This is the Path::Tiny, 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
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   dist_basename
55         my $basename = $zilla->dist_basename;
56
57       This method will return the dist's basename (e.g. "Dist-Name-1.01".
58       The basename is used as the top-level directory in the tarball.  It
59       does not include "-TRIAL", even if building a trial dist.
60
61   archive_filename
62         my $tarball = $zilla->archive_filename;
63
64       This method will return the filename (e.g. "Dist-Name-1.01.tar.gz") of
65       the tarball of this distribution.  It will include "-TRIAL" if building
66       a trial distribution, unless the version contains an underscore.  The
67       tarball might not exist.
68
69   build_archive
70         $zilla->build_archive;
71
72       This method will ensure that the dist has been built, and will then
73       build a tarball of the build directory in the current directory.
74
75   release
76         $zilla->release;
77
78       This method releases the distribution, probably by uploading it to the
79       CPAN.  The actual effects of this method (as with most of the methods)
80       is determined by the loaded plugins.
81
82   clean
83       This method removes temporary files and directories suspected to have
84       been produced by the Dist::Zilla build process.  Specifically, it
85       deletes the .build directory and any entity that starts with the dist
86       name and a hyphen, like matching the glob "Your-Dist-*".
87
88   ensure_built_in_tmpdir
89         $zilla->ensure_built_in_tmpdir;
90
91       This method will consistently build the distribution in a temporary
92       subdirectory. It will return the path for the temporary build location.
93
94   install
95         $zilla->install( \%arg );
96
97       This method installs the distribution locally.  The distribution will
98       be built in a temporary subdirectory, then the process will change
99       directory to that subdir and an installer will be run.
100
101       Valid arguments are:
102
103         keep_build_dir  - if true, don't rmtree the build dir, even if everything
104                           seemed to work
105         install_command - the command to run in the subdir to install the dist
106                           default (roughly): $^X -MCPAN -einstall .
107
108                           this argument should be an arrayref
109
110   test
111         $zilla->test(\%arg);
112
113       This method builds a new copy of the distribution and tests it using
114       "run_tests_in".
115
116       "\%arg" may be omitted.  Otherwise, valid arguments are:
117
118         keep_build_dir  - if true, don't rmtree the build dir, even if everything
119                           seemed to work
120
121   run_tests_in
122         my $error = $zilla->run_tests_in($directory, $arg);
123
124       This method runs the tests in $directory (a Path::Tiny), which must
125       contain an already-built copy of the distribution.  It will throw an
126       exception if there are test failures.
127
128       It does not set any of the *_TESTING environment variables, nor does it
129       clean up $directory afterwards.
130
131   run_in_build
132         $zilla->run_in_build( \@cmd );
133
134       This method makes a temporary directory, builds the distribution there,
135       executes all the dist's BuildRunners (unless directed not to, via
136       "$arg->{build} = 0"), and then runs the given command in the build
137       directory.  If the command exits non-zero, the directory will be left
138       in place.
139

AUTHOR

141       Ricardo SIGNES 😏 <rjbs@cpan.org>
142

144       This software is copyright (c) 2020 by Ricardo SIGNES.
145
146       This is free software; you can redistribute it and/or modify it under
147       the same terms as the Perl 5 programming language system itself.
148
149
150
151perl v5.32.0                      2020-11-03     Dist::Zilla::Dist::Builder(3)
Impressum