NAME

Dist::Zilla::PluginBundle::Author::Plicease - Dist::Zilla plugin bundle used by Plicease

VERSION

version 1.69

SYNOPSIS

In your dist.ini:

[@Author::Plicease]

DESCRIPTION

This Dist::Zilla plugin bundle is mostly equivalent to

# Basic - UploadToCPAN, Readme, ExtraTests, and ConfirmRelease
[GatherDir]
exclude_filename = Makefile.PL
exclude_filename = Build.PL
exclude_filename = cpanfile
exclude_match    = ^_build/
[PruneCruft]
except = .travis.yml
[ManifestSkip]
[MetaYAML]
[License]
[ExecDir]
[ShareDir]
[MakeMaker]
[Manifest]
[TestRelease]

[Author::Plicease::PrePodWeaver]
[PodWeaver]
[NextRelease]
format = %-9v %{yyyy-MM-dd HH:mm:ss Z}d
[AutoPrereqs]
[OurPkgVersion]
[MetaJSON]

[@Git]
allow_dirty = dist.ini
allow_dirty = Changes
allow_dirty = README.md

[Author::Plicease::Resources]
[InstallGuide]
[MinimumPerl]
[ConfirmRelease] 

[ReadmeAnyFromPod]
type     = text
filename = README
location = build

[ReadmeAnyFromPod / ReadMePodInRoot]
type     = markdown
filename = README.md
location = root

[Author::Plicease::MarkDownCleanup]
[Author::Plicease::Recommend]

[Prereqs / NeedTestMore094]
; for subtest
-phase     = test
Test::More = 0.94

[SpecialPrereqs]
[CPANFile]

Some exceptions:

Perl 5.8

[@Git] does not support Perl 5.8, so it is not a prereq there, and it isn't included in the bundle. As a result releasing from Perl 5.8 is not allowed.

MSWin32

Installing [@Git] on MSWin32 is a pain so it is also not a prereq on that platform, isn't used and as a result releasing from MSWin32 is not allowed.

OPTIONS

installer

Specify an alternative to [MakeMaker] ([ModuleBuild], [ModuleBuildTiny], or [ModuleBuildDatabase] for example).

If installer is Alien, then any options with the alien_ prefix will be passed to Alien (minus the alien_ prefix).

If installer is ModuleBuild, then any options with the mb_ prefix will be passed to ModuleBuild (including the mb_ prefix).

If you have a inc/My/ModuleBuild.pm file in your dist, then this plugin bundle will assume installer is ModuleBuild and mb_class = My::ModuleBuild.

readme_from

Which file to pull from for the Readme (must be POD format). If not specified, then the main module will be used.

release_tests

If set to true, then include release tests when building.

release_tests_skip

Passed into the Author::Plicease::Tests if release_tests is true.

travis_status

if set to true, then include a link to the travis build page in the readme.

mb_class

if builder = ModuleBuild, this is the mb_class passed into the [ModuleBuild] plugin.

github_repo

Set the GitHub repo name to something other than the dist name.

github_user

Set the GitHub user name.

copy_mb

Copy Build.PL and cpanfile from the build into the git repository. Exclude them from gather.

This allows other developers to use the dist from the git checkout, without needing to install Dist::Zilla and Dist::Zilla::PluginBundle::Author::Plicease.

allow_dirty

Additional dirty allowed file passed to @Git.

SEE ALSO

Author::Plicease::Init, MintingProfile::Plicease

AUTHOR

Graham Ollis <perl@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Graham Ollis.

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