1Dist::Zilla(3) User Contributed Perl Documentation Dist::Zilla(3)
2
6 Dist::Zilla - distribution builder; installer not included!
7
9 version 4.300002
10
12 Dist::Zilla builds distributions of code to be uploaded to the CPAN.
13 In this respect, it is like ExtUtils::MakeMaker, Module::Build, or
14 Module::Install. Unlike those tools, however, it is not also a system
15 for installing code that has been downloaded from the CPAN. Since it's
16 only run by authors, and is meant to be run on a repository checkout
17 rather than on published, released code, it can do much more than those
18 tools, and is free to make much more ludicrous demands in terms of
19 prerequisites.
20 If you have access to the web, you can learn more and find an
22 interactive tutorial at dzil.org <http://dzil.org/>. If not, try
23 Dist::Zilla::Tutorial.
24
26 name
27 The name attribute (which is required) gives the name of the
28 distribution to be built. This is usually the name of the
29 distribution's main module, with the double colons ("::") replaced with
30 dashes. For example: "Dist-Zilla".
31 version
33 This is the version of the distribution to be created.
34 abstract
36 This is a one-line summary of the distribution. If none is given, one
37 will be looked for in the "main_module" of the dist.
38 main_module
40 This is the module where Dist::Zilla might look for various defaults,
41 like the distribution abstract. By default, it's derived from the
42 distribution name. If your distribution is Foo-Bar, and lib/Foo/Bar.pm
43 exists, that's the main_module. Otherwise, it's the shortest-named
44 module in the distribution. This may change!
45 You can override the default by specifying the file path explicitly,
47 ie:
48 main_module = lib/Foo/Bar.pm
50 license
52 This is the Software::License object for this dist's license and
53 copyright.
54 It will be created automatically, if possible, with the
56 "copyright_holder" and "copyright_year" attributes. If necessary, it
57 will try to guess the license from the POD of the dist's main module.
58 A better option is to set the "license" name in the dist's config to
60 something understandable, like "Perl_5".
61 authors
63 This is an arrayref of author strings, like this:
64 [
66 'Ricardo Signes <rjbs@cpan.org>',
67 'X. Ample, Jr <example@example.biz>',
68 ]
69 This is likely to change at some point in the near future.
71 files
73 This is an arrayref of objects implementing Dist::Zilla::Role::File
74 that will, if left in this arrayref, be built into the dist.
75 Non-core code should avoid altering this arrayref, but sometimes there
77 is not other way to change the list of files. In the future, the
78 representation used for storing files will be changed.
79 root
81 This is the root directory of the dist, as a Path::Class::Dir. It will
82 nearly always be the current working directory in which "dzil" was run.
83 is_trial
85 This attribute tells us whether or not the dist will be a trial
86 release.
87 plugins
89 This is an arrayref of plugins that have been plugged into this
90 Dist::Zilla object.
91 Non-core code must not alter this arrayref. Public access to this
93 attribute may go away in the future.
94 distmeta
96 This is a hashref containing the metadata about this distribution that
97 will be stored in META.yml or META.json. You should not alter the
98 metadata in this hash; use a MetaProvider plugin instead.
99 prereqs
101 This is a Dist::Zilla::Prereqs object, which is a thin layer atop
102 CPAN::Meta::Prereqs, and describes the distribution's prerequisites.
103 logger
105 This attribute stores a Log::Dispatchouli::Proxy object, used to log
106 messages. By default, a proxy to the dist's Chrome is taken.
107 The following methods are delegated from the Dist::Zilla object to the
109 logger:
110 · log
112 · log_debug
114 · log_fatal
116
118 plugin_named
119 my $plugin = $zilla->plugin_named( $plugin_name );
120 plugins_with
122 my $roles = $zilla->plugins_with( -SomeRole );
123 This method returns an arrayref containing all the Dist::Zilla object's
125 plugins that perform a the named role. If the given role name begins
126 with a dash, the dash is replaced with "Dist::Zilla::Role::"
127 find_files
129 my $files = $zilla->find_files( $finder_name );
130 This method will look for a FileFinder-performing plugin with the given
132 name and return the result of calling "find_files" on it. If no plugin
133 can be found, an exception will be raised.
134 stash_named
136 my $stash = $zilla->stash_named( $name );
137 This method will return the stash with the given name, or undef if none
139 exists. It looks for a local stash (for this dist) first, then falls
140 back to a global stash (from the user's global configuration).
141
143 There are usually people on "irc.perl.org" in "#distzilla", even if
144 they're idling.
145 The Dist::Zilla website <http://dzil.org/> has several valuable
147 resources for learning to use Dist::Zilla.
148 There is a mailing list to discuss Dist::Zilla. You can join the list
150 <http://www.listbox.com/subscribe/?list_id=139292> or browse the
151 archives <http://listbox.com/member/archive/139292>.
152
154 Ricardo SIGNES <rjbs@cpan.org>
155
157 This software is copyright (c) 2011 by Ricardo SIGNES.
158 This is free software; you can redistribute it and/or modify it under
160 the same terms as the Perl 5 programming language system itself.
161perl v5.12.4 2011-09-22 Dist::Zilla(3)