This is an automated email from the git hooks/post-receive script. abe pushed a commit to annotated tag 1.001002-source in repository libdist-zilla-role-bootstrap-perl.
commit 56dd11ac13526dbfff39a0d17b9a3578706a3eb8 Author: Kent Fredric <[email protected]> Date: Wed Jul 1 15:04:17 2015 +1200 General maintainer shit --- .gitignore | 6 ++ CONTRIBUTING.pod | 206 ++++++++++++++++++++++++++++++++++++++++++++++++++ Changes | 3 + INSTALL.SKIP | 1 + Makefile.PL | 84 ++++++++++++++++++++ dist.ini | 15 +++- dist.ini.meta | 1 - misc/Changes.deps.all | 6 ++ misc/Changes.deps.dev | 6 ++ 9 files changed, 326 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 62fd55d..d30b2ab 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,8 @@ .build Dist-Zilla-Role-Bootstrap-* +MYMETA.json +MYMETA.yml +Makefile +Makefile.old +blib +pm_to_blib diff --git a/CONTRIBUTING.pod b/CONTRIBUTING.pod new file mode 100644 index 0000000..0350f27 --- /dev/null +++ b/CONTRIBUTING.pod @@ -0,0 +1,206 @@ + +=encoding UTF-8 + +=head1 CONTENTS + +=over 4 + +=item * L</HOW TO CONTRIBUTE> + +=over 4 + +=item * L</Getting dependencies> + +=item * L</Running tests> + +=item * L</Code style and tidying> + +=item * L</Patching documentation> + +=item * L</Installing and using Dist::Zilla> + +=back + +=item * L</OTHER SHORTCUTS> + +=over 4 + +=item * L</Install and Test using a pre-made build branch> + +=item * L<< Locally Patch C<dist.ini> >> + +=over 4 + +=item * L<< /Doing Long-Term C<dist.ini> patches >> + +=back + +=back + +=item * L</CREDITS> + +=back + +=head1 HOW TO CONTRIBUTE + +Thank you for considering contributing to this distribution. This file +contains instructions that will help you work with the source code. + +The distribution is managed with Dist::Zilla. This means than many of the +usual files you might expect are not in the repository, but are generated at +release time, as is much of the documentation. Some generated files are +kept in the repository as a convenience (e.g. Makefile.PL or cpanfile). + +Generally, B<you do not need Dist::Zilla to contribute patches>. You may need +Dist::Zilla to create a tarball. See below for guidance. + +=head2 Getting dependencies + +If you have App::cpanminus 1.6 or later installed, you can use C<cpanm> to +satisfy dependencies like this: + + $ cpanm --installdeps . + +Otherwise, look for either a C<Makefile.PL> or C<cpanfile> file for +a list of dependencies to satisfy. + +=head2 Running tests + +You can run tests directly using the `prove` tool: + + $ prove -l + $ prove -lv t/some_test_file.t + +For most of my distributions, `prove` is entirely sufficient for you to test any +patches you have. I use `prove` for 99% of my testing during development. + +=head2 Code style and tidying + +Please try to match any existing coding style. If there is a C<.perltidyrc> +file, please install Perl::Tidy and use perltidy before submitting patches. + +=head2 Patching documentation + +Much of the documentation Pod is generated at release time. Some is +generated boilerplate; other documentation is built from pseudo-POD +directives in the source like C<=method> or C<=func>. + +If you would like to submit a documentation edit, please limit yourself to +the documentation you see. + +If you see typos or documentation issues in the generated docs, please +email or open a bug ticket instead of patching. + +=head2 Installing and using Dist::Zilla + +Dist::Zilla is a very powerful authoring tool, optimized for maintaining a +large number of distributions with a high degree of automation, but it has a +large dependency chain, a bit of a learning curve and requires a number of +author-specific plugins. + +To install it from CPAN, I recommend one of the following approaches for +the quickest installation: + + # using CPAN.pm, but bypassing non-functional pod tests + $ cpan TAP::Harness::Restricted + $ PERL_MM_USE_DEFAULT=1 HARNESS_CLASS=TAP::Harness::Restricted cpan Dist::Zilla + + # using cpanm, bypassing *all* tests + $ cpanm -n Dist::Zilla + +In either case, it's probably going to take about 10 minutes. Go for a walk, +go get a cup of your favorite beverage, take a bathroom break, or whatever. +When you get back, Dist::Zilla should be ready for you. + +Then you need to install any plugins specific to this distribution: + + $ cpan `dzil authordeps` + $ dzil authordeps | cpanm + +Once installed, here are some dzil commands you might try: + + $ dzil build + $ dzil test + $ dzil xtest + +You can learn more about Dist::Zilla at http://dzil.org/ + +=head1 OTHER SHORTCUTS + +I use a few other tricks that might prove useful to know about when hacking +on my dists. + +=head2 Install and Test using a pre-made build branch + +Most of my repositories come with 1 or more pre-made C<build> branches, which may +occur under any of the following names: + +=over 4 + +=item * C<builds> - my last C<dzil build> + +=item * C<releases> - the build generated for the most recent CPAN release + +=item * C<build/master> ( I<legacy> version of C<builds> ) + +=back + +These branches contain committed copies of my own local C<dzil build> invocations. + +Checking out a copy of these branches with + + git checkout builds + +Will get you a full working built tree, which will look identical to how the distribution +will look once I ship it. + +Having this is not entirely necessary as you should be able to do similar simply working +on the master branch ( with a few caveats around POD handling ) + +But its there if you need it. + +Additionally: These branches are part of my Travis testing infrastructure which help +ascertain that the module will work and pass tests without the benefit of having +3-halves of CPAN due to developer dependencies. + +=head2 Locally Patch C<dist.ini> + +The majority of C<Dist::Zilla> authors ship around a load of shared configuration +in a personal C<@Bundle>, which makes replicating configuration to their different +distributions simpler. + +This has a downside that every time they make a minor tweak to their bundle, everywhere +that was currently using that bundle gets the changes, and not all those changes will +necessarily work with their code. + +The bundle system also makes it tricky for people to simply patch-out single plugins +that are causing local problems for them because they're hidden behind the bundle façade. + +Here, I use a system from generating a frozen snapshot of the state of my bundle: +C<dist.ini> is a flattened unbundled version of C<dist.ini.meta> + +As such, you can tell B<exactly> which plugins are being consumed simply by looking at +C<dist.ini>. And you can tell B<exactly> what their configuration is and their intended +order is. + +So if you're hacking on one of my dists and a plugin or two get in your way and you're +I<wanting> to work with the full C<Dist::Zilla> stack, you can freely just yank them out +and keep on trucking without having to memorize the arcane syntax my bundle requires. + +=head3 Doing Long-Term C<dist.ini> patches + +If you find yourself wanting to make and submit long term changes to dist.ini, B<then> +you I<may> want to look into C<dist.ini.meta>, and see the results of your changes +in C<dist.ini> after making changes by performing: + + dzil bakeini + +This will possibly require installing the following, which are not strictly required for +building my dists: + + Dist::Zilla::PluginBundle::Author::KENTNL + Dist::Zilla::App::Command::bakeini + +=head1 CREDITS + +This file was adapted from an initial C<CONTRIBUTING.mkdn> file from David Golden under the terms of the Apache 2 license. diff --git a/Changes b/Changes index 0a83410..56c6696 100644 --- a/Changes +++ b/Changes @@ -1,6 +1,9 @@ Release history for Dist-Zilla-Role-Bootstrap {{$NEXT}} + [Dependencies::Stats] + - Dependencies changed since 1.001001, see misc/*.deps* for details + - develop: +2 (suggests: ↑1) 1.001001 2015-06-29T09:03:38Z ab79bd2 [Bugfix] diff --git a/INSTALL.SKIP b/INSTALL.SKIP new file mode 100644 index 0000000..31cdaea --- /dev/null +++ b/INSTALL.SKIP @@ -0,0 +1 @@ +CONTRIBUTING.pod$ diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..1ec08ba --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,84 @@ +# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v5.037. +use strict; +use warnings; + +use 5.008; + +use ExtUtils::MakeMaker; + +my %WriteMakefileArgs = ( + "ABSTRACT" => "Shared logic for bootstrap things.", + "AUTHOR" => "Kent Fredric <kentnl\@cpan.org>", + "CONFIGURE_REQUIRES" => { + "ExtUtils::MakeMaker" => 0 + }, + "DISTNAME" => "Dist-Zilla-Role-Bootstrap", + "EXE_FILES" => [], + "LICENSE" => "perl", + "MIN_PERL_VERSION" => "5.008", + "NAME" => "Dist::Zilla::Role::Bootstrap", + "PREREQ_PM" => { + "Carp" => 0, + "Dist::Zilla::Role::Plugin" => 0, + "List::UtilsBy" => 0, + "Moose::Role" => 0, + "Path::Tiny" => 0, + "lib" => 0, + "strict" => 0, + "utf8" => 0, + "version" => 0, + "warnings" => 0 + }, + "TEST_REQUIRES" => { + "Dist::Zilla::Chrome::Test" => 0, + "Dist::Zilla::Dist::Builder" => 0, + "Dist::Zilla::MVP::Assembler::Zilla" => 0, + "Dist::Zilla::MVP::Section" => 0, + "ExtUtils::MakeMaker" => 0, + "File::Copy::Recursive" => 0, + "File::Spec" => 0, + "FindBin" => 0, + "Moose" => 0, + "Test::More" => "0.89" + }, + "VERSION" => "1.001002", + "test" => { + "TESTS" => "t/*.t t/00-compile/*.t" + } +); + + +my %FallbackPrereqs = ( + "Carp" => 0, + "Dist::Zilla::Chrome::Test" => 0, + "Dist::Zilla::Dist::Builder" => 0, + "Dist::Zilla::MVP::Assembler::Zilla" => 0, + "Dist::Zilla::MVP::Section" => 0, + "Dist::Zilla::Role::Plugin" => 0, + "ExtUtils::MakeMaker" => 0, + "File::Copy::Recursive" => 0, + "File::Spec" => 0, + "FindBin" => 0, + "List::UtilsBy" => 0, + "Moose" => 0, + "Moose::Role" => 0, + "Path::Tiny" => 0, + "Test::More" => "0.89", + "lib" => 0, + "strict" => 0, + "utf8" => 0, + "version" => 0, + "warnings" => 0 +); + + +unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { + delete $WriteMakefileArgs{TEST_REQUIRES}; + delete $WriteMakefileArgs{BUILD_REQUIRES}; + $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; +} + +delete $WriteMakefileArgs{CONFIGURE_REQUIRES} + unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; + +WriteMakefile(%WriteMakefileArgs); diff --git a/dist.ini b/dist.ini index 8babc60..3b63822 100644 --- a/dist.ini +++ b/dist.ini @@ -35,7 +35,9 @@ order_by = name exclude_filename = README exclude_filename = README.mkdn exclude_filename = README.pod +exclude_filename = CONTRIBUTING.mkdn exclude_filename = LICENSE +exclude_filename = Makefile.PL include_dotfiles = 1 [License / @Author::KENTNL/License] @@ -49,8 +51,14 @@ include_dotfiles = 1 [Author::KENTNL::TravisCI / @Author::KENTNL/Author::KENTNL::TravisCI] :version = 0.001002 +[Author::KENTNL::CONTRIBUTING / @Author::KENTNL/Author::KENTNL::CONTRIBUTING] +:version = 0.001002 +document_version = 0.1 +format = mkdn + [CopyFilesFromBuild / @Author::KENTNL/CopyXBuild] copy = LICENSE +copy = Makefile.PL [MetaTests / @Author::KENTNL/MetaTests] @@ -86,7 +94,7 @@ replacer = replace_with_blank -phase = develop -type = suggests Dist::Zilla::App::Command::bakeini = 0.001000 -Dist::Zilla::PluginBundle::Author::KENTNL = 2.024002 +Dist::Zilla::PluginBundle::Author::KENTNL = 2.025000 [Prereqs::AuthorDeps / @Author::KENTNL/Prereqs::AuthorDeps] @@ -130,6 +138,7 @@ tag_format = %v-source [Git::NextRelease / @Author::KENTNL/Git::NextRelease] :version = 0.004000 +default_branch = master format = %v %{yyyy-MM-dd'T'HH:mm:ss}dZ %h time_zone = UTC @@ -170,6 +179,8 @@ applyto_phase = develop modules = Dist::Zilla::PluginBundle::Author::KENTNL modules = Dist::Zilla::App::Command::bakeini +[RemovePrereqs::Provided / @Author::KENTNL/RemovePrereqs::Provided] + [Prereqs / @Author::KENTNL/::Role::BundleDeps] ; version_major = 0 ; version_minor = 1 @@ -182,6 +193,7 @@ modules = Dist::Zilla::App::Command::bakeini ; auto_prereqs_skip = File::Find -phase = develop -relationship = requires +Dist::Zilla::Plugin::Author::KENTNL::CONTRIBUTING = 0.001002 Dist::Zilla::Plugin::Author::KENTNL::RecommendFixes = 0.004002 Dist::Zilla::Plugin::Author::KENTNL::TravisCI = 0.001002 Dist::Zilla::Plugin::Authority = 1.006 @@ -217,6 +229,7 @@ Dist::Zilla::Plugin::Prereqs::Recommend::MatchInstalled = 0 Dist::Zilla::Plugin::Prereqs::Upgrade = 0 Dist::Zilla::Plugin::Readme::Brief = 0 Dist::Zilla::Plugin::ReadmeAnyFromPod = 0 +Dist::Zilla::Plugin::RemovePrereqs::Provided = 0 Dist::Zilla::Plugin::RewriteVersion::Sanitized = 0 Dist::Zilla::Plugin::RunExtraTests = 0 Dist::Zilla::Plugin::Test::CPAN::Changes = 0 diff --git a/dist.ini.meta b/dist.ini.meta index 60a4cfd..bb6e026 100644 --- a/dist.ini.meta +++ b/dist.ini.meta @@ -16,7 +16,6 @@ mantissa = 6 toolkit = eumm toolkit_hardness = soft bumpversions = 1 -copyfiles = LICENSE srcreadme = mkdn twitter_extra_hash_tags = #distzilla diff --git a/misc/Changes.deps.all b/misc/Changes.deps.all index 194e374..65d1ede 100644 --- a/misc/Changes.deps.all +++ b/misc/Changes.deps.all @@ -1,6 +1,12 @@ This file contains ALL changes in dependencies in both REQUIRED / OPTIONAL dependencies for all phases (configure/build/runtime/test/develop) 1.001002 + [Added / develop requires] + - Dist::Zilla::Plugin::Author::KENTNL::CONTRIBUTING 0.001002 + - Dist::Zilla::Plugin::RemovePrereqs::Provided + + [Changed / develop suggests] + - Dist::Zilla::PluginBundle::Author::KENTNL 2.024002 → 2.025000 1.001001 2015-06-29T09:03:38Z [Added / develop requires] diff --git a/misc/Changes.deps.dev b/misc/Changes.deps.dev index a1d37be..c025b29 100644 --- a/misc/Changes.deps.dev +++ b/misc/Changes.deps.dev @@ -1,6 +1,12 @@ This file contains changes to DEVELOPMENT dependencies only ( both REQUIRED and OPTIONAL ) 1.001002 + [Added / develop requires] + - Dist::Zilla::Plugin::Author::KENTNL::CONTRIBUTING 0.001002 + - Dist::Zilla::Plugin::RemovePrereqs::Provided + + [Changed / develop suggests] + - Dist::Zilla::PluginBundle::Author::KENTNL 2.024002 → 2.025000 1.001001 2015-06-29T09:03:38Z [Added / develop requires] -- Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libdist-zilla-role-bootstrap-perl.git _______________________________________________ Pkg-perl-cvs-commits mailing list [email protected] http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-perl-cvs-commits
