Skip to content

Test-More/Dist-Zilla-PluginBundle-Test2

Repository files navigation

NAME

Dist::Zilla::PluginBundle::Test2 - The Test2 dzil plugin bundle

VERSION

version 0.01

SYNOPSIS

name    = My-Module
author  = Chad Granum <[email protected]>
license = Artistic_2_0
copyright_holder = Chad Granum

[@Test2]
dist = My-Module
; These files won't be added to tarball
exclude_files = ...
; Default is EXODIST
authority = EXODIST
; Passed to AutoPrereqs - can be repeated
prereqs_skip = ...
; Passed to Test::Pod::Coverage::Configurable if set
pod_coverage_also_private = ...
; Passed to Test::Pod::Coverage::Configurable if set - can be repeated
pod_coverage_class = ...
; Passed to Test::Pod::Coverage::Configurable if set - can be repeated
pod_coverage_skip = ...
; Passed to Test::Pod::Coverage::Configurable if set - can be repeated
pod_coverage_trustme = ...
; For pod spelling test - can be repeated
stopwords = ...
; Can also put them in a separate file
stopwords_file = ..
; Defaults to false
use_github_homepage = 0
; Defaults to false
use_github_issues = 0

DESCRIPTION

This is the Dist::Zilla plugin bundle used for Test2 project distributions. Don't use this directly for your own distributions, but you may find it useful as a source of ideas for building your own bundle.

This bundle uses Dist::Zilla::Role::PluginBundle::PluginRemover and Dist::Zilla::Role::PluginBundle::Config::Slicer so I can remove or configure any plugin as needed.

This is more or less equivalent to the following dist.ini:

[MakeMaker]

[Git::GatherDir]
; Both are configured by setting exclude_files for the bundle. Simple
; values like "./foo/bar.pl" are treated as filenames, others like
; "*\.jnk$" are treated as a regex.
exclude_filenames = ...
exclude_match     = ...

[ManifestSkip]
[License]
[ExecDir]
[ShareDir]
[Manifest]
[CheckVersionIncrement]
[TestRelease]
[ConfirmRelease]
[UploadToCPAN]
[VersionFromMainModule]

[Authority]
; Configured by setting authority for the bundle
authority  = ...
do_munging = 0

[AutoPrereqs]
; Configured by setting skip_prereqs for the bundle
skip = ...

[CopyFilesFromBuild]
copy = CONTRIBUTING.md
copy = LICENSE
copy = Makefile.PL
copy = README.md
copy = cpanfile
copy = ppport.h

[GitHub::Meta]
; Configured by setting use_github_homepage for the bundle
homepage = 0

[MetaResources]
homepage = http://metacpan.org/release/My-Module
; RT bits are omitted if use_github_issue is true
bugtracker.web  = http://rt.cpan.org/Public/Dist/Display.html?Name=My-Module
bugtracker.mail = [email protected]

[MetaProvides::Pckage]
meta_noindex = 1

[Meta::Contributors]
[Meta::Config]
[MetaJSON]
[MetaYAML]

[NextRelease]
; Width is configured by setting next_release_width for the bundle
format = %-8v %{yyyy-MM-dd}d%{ (TRIAL RELEASE)}T

; Scans the test files for use of Test2 and picks either
[Prereqs / Test::More with Test2]
-phase = test
-type  = requires
Test::More = 1.302015

; If the distro doesn't use Test2
[Prereqs / Test::More with subtest]
-phase = test
-type  = requires
Test::More = 0.96

[Prereqs / Modules for use with tidyall]
-phase = develop
-type  = requires
Code::TidyAll::Plugin::Test::Vars = 0.02
Parallel::ForkManager'            = 1.19
Perl::Tidy                        = 20160302
Test::Vars                        = 0.009

[Prereqs / Test::Version which fixes https://github.com/plicease/Test-Version/issues/7]
-phase = develop
-type  = requires
Test::Version = 2.05

[PromptIfStale]
phase  = build
module = Dist::Zilla::PluginBundle::Test2

[PromptIfStale]
phase = release
check_all_plugins = 1
check_all_prereqs = 1
check_authordeps  = 1
skip = Dist::Zilla::Plugin::Test2::TidyAll
skip = Pod::Weaver::PluginBundle::Test2

[Test::Pod::Coverage::Configurable]
; Configured by setting pod_coverage_class for the bundle
class = ...
; Configured by setting pod_coverage_skip for the bundle
skip = ...
; Configured by setting pod_coverage_trustme for the bundle
trustme = ...

[Test::PodSpelling]
; Configured by setting stopwords and/or stopwords_file for the bundle
stopwods = ...

[PodSyntaxTests]

[RunExtraTests]
[MojibakeTests]
[Test::CleanNamespaces]
[Test::CPAN::Changes]
[Test::CPAN::Meta::JSON]
[Test::EOL]
[Test::NoTabs]
[Test::Portability]
[Test::Synopsis]

[Test::TidyAll]
verbose = 1
jobs    = 4
minimum_perl = 5.010

[Test::Compile]
xt_mode = 1

[Test::ReportPrereqs]
verify_prereqs = 1

[Test::Version]
is_strict = 1

; Generates/updates a .mailmap file
[Git::Contributors]

[SurgicalPodWeaver]
; See Pod::Weaver::PluginBundle::Test2 in this same distro for more info
config_plugin = @Test2

[ReadmeAnyFromPod / README.md in build]
type     = markdown
filename = README.md
location = build
phase    = build

[GenerateFile::FromShareDir / Generate CONTRIBUTING.md]
-dist     = Dist-Zilla-PluginBundle-Test2
-filename = CONTRIBUTING.md
; This is determined by looking through the distro for .xs files.
has_xs    = ...

[InstallGuide]
[CPANFile]

; Only added if the distro has .xs files
[PPPort]

[CheckPrereqsIndexed]
[EnsureChangesHasContent]

[Git::CheckFor::MergeConflicts]

; Generates/updates tidyall.ini and perltidyrc
[Test2::TidyAll]

; The allow_dirty list is basically all of the generated or munged files
; in the distro, including:
;     CONTRIBUTING.md
;     Changes
;     LICENSE
;     Makefile.PL
;     README.md
;     cpanfile
;     ppport.h
;     tidyall.ini
[Git::Check]
allow_dirty = ...

[Git::Commit / Commit generated files]
allow_dirty = ...

[Git::Tag]

[BumpVersionAfterRelease]

[Git::Commit / Commit version bump]
allow_dirty_match = .+
commit_msg        = Bump version after release

SUPPORT

Bugs may be submitted at https://github.com/Test-More/Dist-Zilla-PluginBundle-Test2/issues.

Join us on IRC at irc://irc.perl.org/#perl-qa for more help.

We also have a Slack team that can be joined by anyone with an @cpan.org email address https://perl-test2.slack.com/ If you do not have an @cpan.org email you can ask for a Slack invite by emailing Chad Granum [email protected].

SOURCE

The source code repository for Dist-Zilla-PluginBundle-Test2 can be found at https://github.com/Test-More/Dist-Zilla-PluginBundle-Test2.

AUTHOR

Dave Rolsky [email protected]

COPYRIGHT AND LICENSE

This software is Copyright (c) 2017 by Dave Rolsky.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)

The full text of the license can be found in the LICENSE file included with this distribution.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages