NAME
Dist::Zilla::Plugin::MatchManifest - Ensure that MANIFEST is correct
VERSION
This document describes version 6.000 of Dist::Zilla::Plugin::MatchManifest, released December 17, 2017.
SYNOPSIS
[MatchManifest]
require_builder = 1 ; this is the default and should seldom be changedDESCRIPTION
If included, this plugin will ensure that the distribution contains a MANIFEST file and that its contents match the files collected by Dist::Zilla. If not, it will display the differences and offer to update the MANIFEST.
As I see it, there are 2 problems that a MANIFEST can protect against:
A file I don't want to distribute winds up in the tarball
A file I did want to distribute gets left out of the tarball
Dist::Zilla protects against the second problem by using GatherDir plugins that aren't restricted by a MANIFEST file. But the standard Manifest plugin offers no protection against the first problem.
By keeping your MANIFEST under source control and using this plugin to make sure it's kept up to date, you can protect yourself against both problems.
MatchManifest must come after your MakeMaker or ModuleBuild plugin, so that it can see any Makefile.PL or Build.PL generated.
ATTRIBUTES
require_builder
For safety, MatchManifest aborts if it doesn't see a Makefile.PL or Build.PL in your dist. If [MatchManifest] is listed before [MakeMaker] in your dist.ini, then the manifest will be checked before Makefile.PL has been added, which is bad.
If you really want to create a dist with no Makefile.PL or Build.PL, you can set require_builder to 0 to skip this check.
CONFIGURATION AND ENVIRONMENT
Dist::Zilla::Plugin::MatchManifest requires no configuration files or environment variables.
INCOMPATIBILITIES
None reported.
BUGS AND LIMITATIONS
No bugs have been reported.
AUTHOR
Christopher J. Madsen <perl AT cjmweb.net>
Please report any bugs or feature requests to <bug-Dist-Zilla-Plugin-MatchManifest AT rt.cpan.org> or through the web interface at http://rt.cpan.org/Public/Bug/Report.html?Queue=Dist-Zilla-Plugin-MatchManifest.
You can follow or contribute to Dist-Zilla-Plugin-MatchManifest's development at https://github.com/madsen/dist-zilla-plugin-matchmanifest.
COPYRIGHT AND LICENSE
This software is copyright (c) 2017 by Christopher J. Madsen.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.