NAME

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

VERSION

version 0.003

SYNOPSIS

In your dist.ini:

    ; when you are confident this is correct
    [StaticInstall]
    mode = on

    ; be conservative; just tell us what the value should be
    [StaticInstall]
    mode = auto
    dry_run = 1

DESCRIPTION

This is a Dist::Zilla plugin that, when mode is on, provides the following distribution metadata:

    x_static_install : "1"

The definition of a "static installation" is still being refined by the Perl Toolchain Gang. Use with discretion!

The current preconditions for x_static_install being true include:

• dynamic_config must be false in metadata

• no prerequisites in configure-requires other than ExtUtils::MakeMaker, Module::Build::Tiny, or File::ShareDir::Install

• no prerequisites in build-requires

• no installer plugins permitted other than:

  • Dist::Zilla::Plugin::MakeMaker

  • Dist::Zilla::Plugin::MakeMaker::Fallback

  • Dist::Zilla::Plugin::ModuleBuildTiny

  • Dist::Zilla::Plugin::ModuleBuildTiny::Fallback

• an installer plugin from the above list must be used (a manually-generated Makefile.PL or Build.PL is not permitted)

• no other plugins may modify Makefile.PL nor Build.PL

• the [MetaJSON] plugin must be used, at (the default) meta-spec version 2

• no .xs files may be present

CONFIGURATION OPTIONS

mode

When set to on, the value of x_static_install is set to 1 (the normal usecase).

When set to off, the value of x_static_install is set to 0, which is equivalent to not providing this field at all.

When set to auto, we attempt to calculate the proper value. When used with dry_run = 1, the value isn't actually stored, but just provided in a diagnostic message. This is the recommended usage in a plugin bundle, for testing against a number of distributions at once.

The calculations are always performed, no matter the value of mode -- if it comes up with a different result than what you are setting, this is logged. If mode = on and the calculations discover the distribution is ineligible for this flag, the build fails, to prevent you from releasing bad metadata.

dry_run

When true, no value is set in metadata, but verbose logging is enabled so you can see what the value would have been.

SUPPORT

Bugs may be submitted through the RT bug tracker (or bug-Dist-Zilla-Plugin-StaticInstall@rt.cpan.org). I am also usually active on irc, as 'ether' at irc.perl.org.

SEE ALSO

• CPAN::Meta::Spec

AUTHOR

Karen Etheridge <ether@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Karen Etheridge.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.