1Dist::Zilla::App::CommaUnsde:r:bCuoinltdr(i3b)uted PerlDDiosctu:m:eZnitlaltai:o:nApp::Command::build(3)
2
3
4
6 Dist::Zilla::App::Command::build - build your dist
7
9 version 6.031
10
12 dzil build [ --trial ] [ --tgz | --no-tgz ] [ --in /path/to/build/dir ]
13
15 This command is a very thin layer over the Dist::Zilla "build" method,
16 which does all the things required to build your distribution. By
17 default, it will also archive your distribution and leave you with a
18 complete, ready-to-release distribution tarball.
19
20 To go a bit further in depth, the "build" command will do two things:
21
22 • Generate a directory containing your module, "Foo-0.100". This
23 directory is complete. You could create a gzipped tarball from this
24 directory and upload it directly to "PAUSE" if you so desired. You
25 could "cd" into this directory and test your module on Perl
26 installations where you don't have "Dist::Zilla", for example.
27
28 This is a default behavior of the "build" command. You can alter
29 where it puts the directory with "--in /path/to/build/dir".
30
31 • Generate a gzipped tarball of your module, "Foo-0.100.tar.gz". This
32 file could be uploaded directly to "PAUSE" to make a release of
33 your module if you wanted. Or, you can test your module: "cpanm
34 --test-only Foo-0.100.tar.gz". This is the same thing you would
35 get if you compressed the directory described above.
36
37 The gzipped tarball is generated by default, but if you don't want
38 it to be generated, you can pass the "--no-tgz" option. In that
39 case, it would only generate the directory described above.
40
41 Once you're done testing or publishing your build, you can clean up
42 everything with a "dzil clean".
43
45 This module should work on any version of perl still receiving updates
46 from the Perl 5 Porters. This means it should work on any version of
47 perl released in the last two to three years. (That is, if the most
48 recently released version is v5.40, then this module should work on
49 both v5.40 and v5.38.)
50
51 Although it may work on older versions of perl, no guarantee is made
52 that the minimum required version will not be increased. The version
53 may be increased for any reason, and there is no promise that patches
54 will be accepted to lower the minimum required perl.
55
57 $ dzil build
58 $ dzil build --no-tgz
59 $ dzil build --in /path/to/build/dir
60
62 --trial
63 This will build a trial distribution. Among other things, it will
64 generally mean that the built tarball's basename ends in -TRIAL.
65
66 --tgz | --no-tgz
67 Builds a .tar.gz in your project directory after building the
68 distribution.
69
70 --tgz behaviour is by default, use --no-tgz to disable building an
71 archive.
72
73 --in
74 Specifies the directory into which the distribution should be built.
75 If necessary, the directory will be created. An archive will not be
76 created.
77
79 Ricardo SIGNES 😏 <cpan@semiotic.systems>
80
82 This software is copyright (c) 2023 by Ricardo SIGNES.
83
84 This is free software; you can redistribute it and/or modify it under
85 the same terms as the Perl 5 programming language system itself.
86
87
88
89perl v5.36.1 2023-11-21Dist::Zilla::App::Command::build(3)