Dist::Zilla::Plugin::AssertOS - Require that our distribution is running on a particular OS
# In dist.ini - It is important that AssertOS follows MakeMaker or # ModuleBuild [MakeMaker] [AssertOS] os = Linux os = FreeBSD os = cygwin
The resultant distribution will die at
Makefile.PL unless the platform the code is running on is Linux, FreeBSD or Cygwin.
Dist::Zilla::Plugin::AssertOS is a Dist::Zilla plugin that integrates Devel::AssertOS so that CPAN authors may easily stipulate which particular OS environments their distributions may be built and installed on.
The author specifies which OS or OS families are supported. The necessary Devel::AssertOS files are copied to the
inc/ directory and
Build.PL is mungled to include the necessary incantation.
On the module user side, the bundled
inc/ Devel::AssertOS determines whether the current environment is supported or not and will die accordingly.
As this plugin mungles the
Build.PL it is imperative that it is specified in
This plugin also automagically adds the
no_index metadata so that
inc/ is excluded from PAUSE indexing. If you use Dist::Zilla::Plugin::MetaNoIndex, there may be conflicts.
If set to c<0> Devel::AssertOS will not be bundled in the distribution. It will instead be added to
METAfiles so CPAN clients can install it before running
Makefile.PL. The default is
1, so Devel::AssertOS is bundled in
These are required by the roles that this plugin uses.
Required by Dist::Zilla::Role::FileGatherer.
Required by Dist::Zilla::Role::InstallTool.
Required by Dist::Zilla::Role::MetaProvider.
Based on use-devel-assertos by David Cantrell
Build.PL support contributed by Yanick Champoux
Chris Williams <email@example.com>
COPYRIGHT AND LICENSE
This software is copyright (c) 2013 by Chris Williams and David Cantrell.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.