Dist::Zilla::Plugin::StaticInstall(3pm)

1Dist::Zilla::Plugin::StUasteircICnosnttarlilb(u3tpemd)PDeirslt:D:oZciulmlean:t:aPtliuognin::StaticInstall(3pm)
2
3
4

NAME

6       Dist::Zilla::Plugin::StaticInstall - Identify a distribution as
7       eligible for static installation
8

VERSION

10       version 0.012
11

SYNOPSIS

13       In your dist.ini:
14
15           ; when you are confident this is correct
16           [StaticInstall]
17           mode = on
18
19           ; trust us to set the right value (DANGER!)
20           [StaticInstall]
21           mode = auto
22
23           ; be conservative; just tell us what the value should be
24           [StaticInstall]
25           mode = auto
26           dry_run = 1
27

DESCRIPTION

29       This is a Dist::Zilla plugin that, when "mode" is "on", provides the
30       following distribution metadata:
31
32           x_static_install : "1"
33
34       The plugin performs a number of checks against the distribution to
35       determine the proper value of the "x_static_install" metadata field.
36       When set to a true value, this indicates that the can skip a number of
37       installation steps (such as running Makefile.PL or Build.PL and acting
38       on its side effects).
39
40       The definition of a "static installation" is being prototyped by the
41       Perl Toolchain Gang and is still being refined.  DO NOT USE THIS PLUGIN
42       if you are not involved in this testing. The proper installation of the
43       built distribution cannot be guaranteed if installed with a static
44       install-enabled client.
45
46       The tentative specification is spelled out in more detail in
47       <https://github.com/Leont/cpan-static/blob/master/lib/CPAN/Static/Spec.pm>.
48
49       This plugin currently checks these conditions (if all are true,
50       "x_static_install" can be true):
51
52       •   "dynamic_config" must be false in metadata
53
54       •   no prerequisites in configure-requires other than
55           ExtUtils::MakeMaker, Module::Build::Tiny, or
56           File::ShareDir::Install
57
58       •   no prerequisites in build-requires
59
60       •   no files to be installed as executables outside of the script
61           directory
62
63       •   no module sharedir (a distribution sharedir is okay)
64
65       •   no installer plugins permitted other than:
66
67           •   Dist::Zilla::Plugin::MakeMaker
68
69           •   Dist::Zilla::Plugin::MakeMaker::Fallback
70
71           •   Dist::Zilla::Plugin::ModuleBuildTiny
72
73           •   Dist::Zilla::Plugin::ModuleBuildTiny::Fallback
74
75       •   an installer plugin from the above list must be used (a manually-
76           generated Makefile.PL or Build.PL is not permitted)
77
78       •   no other plugins may modify Makefile.PL nor Build.PL
79
80       •   the "[MetaJSON]" plugin must be used, at (the default) meta-spec
81           version 2
82
83       •   no .xs files may be present
84
85       •   .pm, .pod, .pl files may not be present in the root of the
86           distribution or in "BASEEXT" (where "BASEEXT" is the last component
87           of the distribution name)
88
89       •   .pmc and .PL files (excluding Makefile.PL, Build.PL) may not be
90           present
91
92       •   files in lib/ other than .pod, .pm may not be present
93

CONFIGURATION OPTIONS

95   "mode"
96       When set to "on", the value of "x_static_install" is set to 1 (the
97       normal usecase).
98
99       When set to "off", the value of "x_static_install" is set to 0, which
100       is equivalent to not providing this field at all.
101
102       When set to "auto", we attempt to calculate the proper value. When used
103       with "dry_run = 1", the value isn't actually stored, but just provided
104       in a diagnostic message. This is the recommended usage in a plugin
105       bundle, for testing against a number of distributions at once.
106
107       The calculations are always performed, no matter the value of "mode" --
108       if it comes up with a different result than what you are setting, this
109       is logged. If "mode = on" and the calculations discover the
110       distribution is ineligible for this flag, the build fails, to prevent
111       you from releasing bad metadata.
112
113   "dry_run"
114       When true, no value is set in metadata, but verbose logging is enabled
115       so you can see what the value would have been.
116

SUPPORT

123       Bugs may be submitted through the RT bug tracker
124       <https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-
125       StaticInstall> (or bug-Dist-Zilla-Plugin-StaticInstall@rt.cpan.org
126       <mailto:bug-Dist-Zilla-Plugin-StaticInstall@rt.cpan.org>).
127
128       There is also a mailing list available for users of this distribution,
129       at <http://dzil.org/#mailing-list>.
130
131       There is also an irc channel available for users of this distribution,
132       at "#distzilla" on "irc.perl.org" <irc://irc.perl.org/#distzilla>.
133
134       I am also usually active on irc, as 'ether' at "irc.perl.org".
135

AUTHOR

137       Karen Etheridge <ether@cpan.org>
138

COPYRIGHT AND LICENCE

140       This software is copyright (c) 2015 by Karen Etheridge.
141
142       This is free software; you can redistribute it and/or modify it under
143       the same terms as the Perl 5 programming language system itself.
144
145
146
147perl v5.34.0                      2022-0D1i-s2t1::Zilla::Plugin::StaticInstall(3pm)