From: Charles McGarvey Date: Fri, 25 Nov 2016 22:51:13 +0000 (-0700) Subject: initial commit X-Git-Tag: v0.001~1 X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fp5-Dist-Zilla-PluginBundle-Author-CCM;a=commitdiff_plain;h=fb8925433e905ddc2f5c7dd8d74d51eff4994cbb initial commit --- fb8925433e905ddc2f5c7dd8d74d51eff4994cbb diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ab60af4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +*.bs +*.o +*.tar* +*~ +/.build +/.perl-version +/Dist-Zilla-PluginBundle-Author-CCM-* +/MYMETA.* +/Makefile +/blib +/local* +/pm_to_blib diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..86a7da9 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,25 @@ +sudo: false +language: perl +perl: + - 'blead' + - '5.20' + - '5.18' + - '5.16' + - '5.14' + - '5.12' + - '5.10' + - '5.8' +matrix: + allow_failures: + - perl: 'blead' + - perl: '5.8' + fast_finish: true +before_install: + - git config --global user.name "TravisCI" + - git config --global user.email $HOSTNAME":not-for-mail@travis-ci.org" +install: + - cpanm --quiet --notest --skip-satisfied Dist::Zilla + - "dzil authordeps --missing | grep -vP '[^\\w:]' | xargs -n 5 -P 10 cpanm --quiet --notest" + - "dzil listdeps --author --missing | grep -vP '[^\\w:]' | cpanm --verbose" +script: + - dzil smoke --release --author diff --git a/Changes b/Changes new file mode 100644 index 0000000..15e3317 --- /dev/null +++ b/Changes @@ -0,0 +1,4 @@ +Revision history for Dist-Zilla-PluginBundle-Author-CCM. + +{{$NEXT}} + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1935df6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,379 @@ +This software is copyright (c) 2016 by Charles McGarvey. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +Terms of the Perl programming language system itself + +a) the GNU General Public License as published by the Free + Software Foundation; either version 1, or (at your option) any + later version, or +b) the "Artistic License" + +--- The GNU General Public License, Version 1, February 1989 --- + +This software is Copyright (c) 2016 by Charles McGarvey. + +This is free software, licensed under: + + The GNU General Public License, Version 1, February 1989 + + GNU GENERAL PUBLIC LICENSE + Version 1, February 1989 + + Copyright (C) 1989 Free Software Foundation, Inc. + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The license agreements of most software companies try to keep users +at the mercy of those companies. By contrast, our General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. The +General Public License applies to the Free Software Foundation's +software and to any other program whose authors commit to using it. +You can use it for your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Specifically, the General Public License is designed to make +sure that you have the freedom to give away or sell copies of free +software, that you receive source code or can get it if you want it, +that you can change the software or use pieces of it in new free +programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of a such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must tell them their rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any program or other work which +contains a notice placed by the copyright holder saying it may be +distributed under the terms of this General Public License. The +"Program", below, refers to any such program or work, and a "work based +on the Program" means either the Program or any work containing the +Program or a portion of it, either verbatim or with modifications. Each +licensee is addressed as "you". + + 1. You may copy and distribute verbatim copies of the Program's source +code as you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this +General Public License and to the absence of any warranty; and give any +other recipients of the Program a copy of this General Public License +along with the Program. You may charge a fee for the physical act of +transferring a copy. + + 2. You may modify your copy or copies of the Program or any portion of +it, and copy and distribute such modifications under the terms of Paragraph +1 above, provided that you also do the following: + + a) cause the modified files to carry prominent notices stating that + you changed the files and the date of any change; and + + b) cause the whole of any work that you distribute or publish, that + in whole or in part contains the Program or any part thereof, either + with or without modifications, to be licensed at no charge to all + third parties under the terms of this General Public License (except + that you may choose to grant warranty protection to some or all + third parties, at your option). + + c) If the modified program normally reads commands interactively when + run, you must cause it, when started running for such interactive use + in the simplest and most usual way, to print or display an + announcement including an appropriate copyright notice and a notice + that there is no warranty (or else, saying that you provide a + warranty) and that users may redistribute the program under these + conditions, and telling the user how to view a copy of this General + Public License. + + d) You may charge a fee for the physical act of transferring a + copy, and you may at your option offer warranty protection in + exchange for a fee. + +Mere aggregation of another independent work with the Program (or its +derivative) on a volume of a storage or distribution medium does not bring +the other work under the scope of these terms. + + 3. You may copy and distribute the Program (or a portion or derivative of +it, under Paragraph 2) in object code or executable form under the terms of +Paragraphs 1 and 2 above provided that you also do one of the following: + + a) accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of + Paragraphs 1 and 2 above; or, + + b) accompany it with a written offer, valid for at least three + years, to give any third party free (except for a nominal charge + for the cost of distribution) a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of + Paragraphs 1 and 2 above; or, + + c) accompany it with the information you received as to where the + corresponding source code may be obtained. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form alone.) + +Source code for a work means the preferred form of the work for making +modifications to it. For an executable file, complete source code means +all the source code for all modules it contains; but, as a special +exception, it need not include source code for modules which are standard +libraries that accompany the operating system on which the executable +file runs, or for standard header files or definitions files that +accompany that operating system. + + 4. You may not copy, modify, sublicense, distribute or transfer the +Program except as expressly provided under this General Public License. +Any attempt otherwise to copy, modify, sublicense, distribute or transfer +the Program is void, and will automatically terminate your rights to use +the Program under this License. However, parties who have received +copies, or rights to use copies, from you under this General Public +License will not have their licenses terminated so long as such parties +remain in full compliance. + + 5. By copying, distributing or modifying the Program (or any work based +on the Program) you indicate your acceptance of this license to do so, +and all its terms and conditions. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the original +licensor to copy, distribute or modify the Program subject to these +terms and conditions. You may not impose any further restrictions on the +recipients' exercise of the rights granted herein. + + 7. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of the license which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +the license, you may choose any version ever published by the Free Software +Foundation. + + 8. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "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 PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 10. 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 PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to humanity, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + + To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively convey +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) 19yy + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 1, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19xx name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the +appropriate parts of the General Public License. Of course, the +commands you use may be called something other than `show w' and `show +c'; they could even be mouse-clicks or menu items--whatever suits your +program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + program `Gnomovision' (a program to direct compilers to make passes + at assemblers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +That's all there is to it! + + +--- The Artistic License 1.0 --- + +This software is Copyright (c) 2016 by Charles McGarvey. + +This is free software, licensed under: + + The Artistic License 1.0 + +The Artistic License + +Preamble + +The intent of this document is to state the conditions under which a Package +may be copied, such that the Copyright Holder maintains some semblance of +artistic control over the development of the package, while giving the users of +the package the right to use and distribute the Package in a more-or-less +customary fashion, plus the right to make reasonable modifications. + +Definitions: + + - "Package" refers to the collection of files distributed by the Copyright + Holder, and derivatives of that collection of files created through + textual modification. + - "Standard Version" refers to such a Package if it has not been modified, + or has been modified in accordance with the wishes of the Copyright + Holder. + - "Copyright Holder" is whoever is named in the copyright or copyrights for + the package. + - "You" is you, if you're thinking about copying or distributing this Package. + - "Reasonable copying fee" is whatever you can justify on the basis of media + cost, duplication charges, time of people involved, and so on. (You will + not be required to justify it to the Copyright Holder, but only to the + computing community at large as a market that must bear the fee.) + - "Freely Available" means that no fee is charged for the item itself, though + there may be fees involved in handling the item. It also means that + recipients of the item may redistribute it under the same conditions they + received it. + +1. You may make and give away verbatim copies of the source form of the +Standard Version of this Package without restriction, provided that you +duplicate all of the original copyright notices and associated disclaimers. + +2. You may apply bug fixes, portability fixes and other modifications derived +from the Public Domain or from the Copyright Holder. A Package modified in such +a way shall still be considered the Standard Version. + +3. You may otherwise modify your copy of this Package in any way, provided that +you insert a prominent notice in each changed file stating how and when you +changed that file, and provided that you do at least ONE of the following: + + a) place your modifications in the Public Domain or otherwise make them + Freely Available, such as by posting said modifications to Usenet or an + equivalent medium, or placing the modifications on a major archive site + such as ftp.uu.net, or by allowing the Copyright Holder to include your + modifications in the Standard Version of the Package. + + b) use the modified Package only within your corporation or organization. + + c) rename any non-standard executables so the names do not conflict with + standard executables, which must also be provided, and provide a separate + manual page for each non-standard executable that clearly documents how it + differs from the Standard Version. + + d) make other distribution arrangements with the Copyright Holder. + +4. You may distribute the programs of this Package in object code or executable +form, provided that you do at least ONE of the following: + + a) distribute a Standard Version of the executables and library files, + together with instructions (in the manual page or equivalent) on where to + get the Standard Version. + + b) accompany the distribution with the machine-readable source of the Package + with your modifications. + + c) accompany any non-standard executables with their corresponding Standard + Version executables, giving the non-standard executables non-standard + names, and clearly documenting the differences in manual pages (or + equivalent), together with instructions on where to get the Standard + Version. + + d) make other distribution arrangements with the Copyright Holder. + +5. You may charge a reasonable copying fee for any distribution of this +Package. You may charge any fee you choose for support of this Package. You +may not charge a fee for this Package itself. However, you may distribute this +Package in aggregate with other (possibly commercial) programs as part of a +larger (possibly commercial) software distribution provided that you do not +advertise this Package as a product of your own. + +6. The scripts and library files supplied as input to or produced as output +from the programs of this Package do not automatically fall under the copyright +of this Package, but belong to whomever generated them, and may be sold +commercially, and may be aggregated with this Package. + +7. C or perl subroutines supplied by you and linked into this Package shall not +be considered part of this Package. + +8. The name of the Copyright Holder may not be used to endorse or promote +products derived from this software without specific prior written permission. + +9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF +MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + +The End + diff --git a/README.md b/README.md new file mode 100644 index 0000000..927a5f1 --- /dev/null +++ b/README.md @@ -0,0 +1,160 @@ +# NAME + +Dist::Zilla::PluginBundle::Author::CCM - A plugin bundle for distributions built by CCM + +# VERSION + +version 0.001 + +# SYNOPSIS + + # In your dist.ini file: + [@Author::CCM] + +# DESCRIPTION + +You probably don't want to use this. + + ; VERSION + [Git::NextVersion] + [NextRelease] + [ReversionOnRelease] + prompt = 1 + + [ExecDir] + [ExtraTests] + + ; GATHER + [Git::GatherDir] + exclude_filename = LICENSE + exclude_filename = README.md + [PruneCruft] + [PruneFiles] + filename = dist.ini + + [CopyFilesFromBuild] + copy = LICENSE + + ; PREREQS + [AutoPrereqs] + [Prereqs::FromCPANfile] ; if a cpanfile exists in root + [Prereqs::AuthorDeps] + + ; TESTS + [MetaTests] + [Test::CPAN::Changes] + [PodCoverageTests] + [PodSyntaxTests] + [Test::Pod::No404s] + [Test::Compile] + [Test::EOL] + [Test::NoTabs] + [Test::Perl::Critic] + [Test::Portability] + [Test::CleanNamespaces] + [Test::ReportPrereqs] + + ; METADATA + [Authority] + do_munging = 0 + [MetaJSON] + [MetaYAML] + [MetaNoIndex] + directory = eg + directory = share + directory = shares + directory = t + directory = xt + [MetaProvides::Package] + [Keywords] + [Git::Contributors] + order_by = commits + [GithubMeta] + issues = 1 + + ; MUNGE + [PodWeaver] + config_plugin = @Author::CCM + [OverridePkgVersion] + + ; GENERATE FILES + [License] + [ReadmeAnyFromPod] + filename = README.md + locaton = root + type = markdown + [ReadmeAnyFromPod] + filename = README + location = build + type = text + [TravisYML] + [Manifest] + [ManifestSkip] + + [MakeMaker] ; override with the "installer" attribute + + ; RELEASE + [CheckChangesHasContent] + [Git::Check] + [TestRelease] + [ConfirmRelease] + [UploadToCPAN] ; disable with the "no_upload" attribute + [Git::Commit] + commit_msg = Release %N %v%t%n%n%c + [Git::CommitBuild] + branch = + release_branch = dist + release_message = Version %v%t + [Git::Tag] + tag_message = Version %v%t%n%n%c + [Git::Push] + push_to = origin master +master:refs/heads/release +dist + remotes_must_exist = 0 + +# ATTRIBUTES + +## installer + +Specify which installer to use, such as: + +- `MakeMaker` (default) +- `MakeMaker::Custom` + +## airplane + +Disable plugins that use the network, and prevent releasing. + +## no\_upload + +Do not upload to CPAN. + +# METHODS + +## configure + +Required by [Dist::Zilla::Role::PluginBundle::Easy](https://metacpan.org/pod/Dist::Zilla::Role::PluginBundle::Easy). + +# SEE ALSO + +- [Dist::Zilla](https://metacpan.org/pod/Dist::Zilla) +- [Dist::Zilla::PluginBundle::Author::ETHER](https://metacpan.org/pod/Dist::Zilla::PluginBundle::Author::ETHER) + +# BUGS + +Please report any bugs or feature requests on the bugtracker website +[https://github.com/chazmcgarvey/Dist-Zilla-PluginBundle-Author-CCM/issues](https://github.com/chazmcgarvey/Dist-Zilla-PluginBundle-Author-CCM/issues) + +When submitting a bug or request, please include a test-file or a +patch to an existing test-file that illustrates the bug or desired +feature. + +# AUTHOR + +Charles McGarvey + +# COPYRIGHT AND LICENSE + +This software is copyright (c) 2016 by Charles McGarvey. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. diff --git a/cpanfile b/cpanfile new file mode 100644 index 0000000..bde24eb --- /dev/null +++ b/cpanfile @@ -0,0 +1,71 @@ +# requires 'Badge::Depot::Plugin::Coverage'; +# requires 'Badge::Depot::Plugin::Perl'; +# requires 'Badge::Depot::Plugin::Travis'; +# requires 'Pod::Weaver::Section::Badges'; +requires 'Dist::Zilla::Plugin::Authority'; +requires 'Dist::Zilla::Plugin::AutoPrereqs'; +requires 'Dist::Zilla::Plugin::BlockRelease'; +requires 'Dist::Zilla::Plugin::CheckChangesHasContent'; +requires 'Dist::Zilla::Plugin::ConfirmRelease'; +requires 'Dist::Zilla::Plugin::CopyFilesFromBuild'; +requires 'Dist::Zilla::Plugin::Encoding'; +requires 'Dist::Zilla::Plugin::ExecDir'; +requires 'Dist::Zilla::Plugin::ExtraTests'; +requires 'Dist::Zilla::Plugin::FakeRelease'; +requires 'Dist::Zilla::Plugin::Git::Check'; +requires 'Dist::Zilla::Plugin::Git::Commit'; +requires 'Dist::Zilla::Plugin::Git::CommitBuild'; +requires 'Dist::Zilla::Plugin::Git::Contributors'; +requires 'Dist::Zilla::Plugin::Git::GatherDir'; +requires 'Dist::Zilla::Plugin::Git::NextVersion'; +requires 'Dist::Zilla::Plugin::Git::Push'; +requires 'Dist::Zilla::Plugin::Git::Tag'; +requires 'Dist::Zilla::Plugin::GithubMeta'; +requires 'Dist::Zilla::Plugin::Keywords'; +requires 'Dist::Zilla::Plugin::License'; +requires 'Dist::Zilla::Plugin::MakeMaker'; +requires 'Dist::Zilla::Plugin::Manifest'; +requires 'Dist::Zilla::Plugin::ManifestSkip'; +requires 'Dist::Zilla::Plugin::MetaJSON'; +requires 'Dist::Zilla::Plugin::MetaNoIndex'; +requires 'Dist::Zilla::Plugin::MetaProvides::Package'; +requires 'Dist::Zilla::Plugin::MetaTests'; +requires 'Dist::Zilla::Plugin::MetaYAML'; +requires 'Dist::Zilla::Plugin::NextRelease'; +requires 'Dist::Zilla::Plugin::OverridePkgVersion'; +requires 'Dist::Zilla::Plugin::PodCoverageTests'; +requires 'Dist::Zilla::Plugin::PodSyntaxTests'; +requires 'Dist::Zilla::Plugin::PodWeaver'; +requires 'Dist::Zilla::Plugin::Prereqs::AuthorDeps'; +requires 'Dist::Zilla::Plugin::Prereqs::FromCPANfile'; +requires 'Dist::Zilla::Plugin::PruneCruft'; +requires 'Dist::Zilla::Plugin::PruneFiles'; +requires 'Dist::Zilla::Plugin::ReadmeAnyFromPod'; +requires 'Dist::Zilla::Plugin::ReversionOnRelease'; +requires 'Dist::Zilla::Plugin::Test::CPAN::Changes'; +requires 'Dist::Zilla::Plugin::Test::CleanNamespaces'; +requires 'Dist::Zilla::Plugin::Test::Compile'; +requires 'Dist::Zilla::Plugin::Test::EOL'; +requires 'Dist::Zilla::Plugin::Test::NoTabs'; +requires 'Dist::Zilla::Plugin::Test::Perl::Critic'; +requires 'Dist::Zilla::Plugin::Test::Pod::No404s'; +requires 'Dist::Zilla::Plugin::Test::Portability'; +requires 'Dist::Zilla::Plugin::Test::ReportPrereqs'; +requires 'Dist::Zilla::Plugin::TestRelease'; +requires 'Dist::Zilla::Plugin::TravisYML'; +requires 'Dist::Zilla::Plugin::UploadToCPAN'; +requires 'Pod::Elemental::Transformer::List'; +requires 'Pod::Elemental::Transformer::Verbatim'; +requires 'Pod::Weaver::Plugin::EnsurePod5'; +requires 'Pod::Weaver::Plugin::H1Nester'; +requires 'Pod::Weaver::Plugin::SingleEncoding'; +requires 'Pod::Weaver::Plugin::Transformer'; +requires 'Pod::Weaver::Section::Authors'; +requires 'Pod::Weaver::Section::Bugs'; +requires 'Pod::Weaver::Section::Collect'; +requires 'Pod::Weaver::Section::Contributors'; +requires 'Pod::Weaver::Section::Generic'; +requires 'Pod::Weaver::Section::Legal'; +requires 'Pod::Weaver::Section::Name'; +requires 'Pod::Weaver::Section::Region'; +requires 'Pod::Weaver::Section::Version'; diff --git a/dist.ini b/dist.ini new file mode 100644 index 0000000..73e772f --- /dev/null +++ b/dist.ini @@ -0,0 +1,8 @@ + +name = Dist-Zilla-PluginBundle-Author-CCM +author = Charles McGarvey +license = Perl_5 +copyright_holder = Charles McGarvey + +[@Author::CCM] + diff --git a/lib/Dist/Zilla/PluginBundle/Author/CCM.pm b/lib/Dist/Zilla/PluginBundle/Author/CCM.pm new file mode 100644 index 0000000..a8a327f --- /dev/null +++ b/lib/Dist/Zilla/PluginBundle/Author/CCM.pm @@ -0,0 +1,278 @@ +package Dist::Zilla::PluginBundle::Author::CCM; +# ABSTRACT: A plugin bundle for distributions built by CCM +# KEYWORDS: dzil author bundle distribution tool + +=head1 SYNOPSIS + + # In your dist.ini file: + [@Author::CCM] + +=head1 DESCRIPTION + +You probably don't want to use this. + + ; VERSION + [Git::NextVersion] + [NextRelease] + [ReversionOnRelease] + prompt = 1 + + [ExecDir] + [ExtraTests] + + ; GATHER + [Git::GatherDir] + exclude_filename = LICENSE + exclude_filename = README.md + [PruneCruft] + [PruneFiles] + filename = dist.ini + + [CopyFilesFromBuild] + copy = LICENSE + + ; PREREQS + [AutoPrereqs] + [Prereqs::FromCPANfile] ; if a cpanfile exists in root + [Prereqs::AuthorDeps] + + ; TESTS + [MetaTests] + [Test::CPAN::Changes] + [PodCoverageTests] + [PodSyntaxTests] + [Test::Pod::No404s] + [Test::Compile] + [Test::EOL] + [Test::NoTabs] + [Test::Perl::Critic] + [Test::Portability] + [Test::CleanNamespaces] + [Test::ReportPrereqs] + + ; METADATA + [Authority] + do_munging = 0 + [MetaJSON] + [MetaYAML] + [MetaNoIndex] + directory = eg + directory = share + directory = shares + directory = t + directory = xt + [MetaProvides::Package] + [Keywords] + [Git::Contributors] + order_by = commits + [GithubMeta] + issues = 1 + + ; MUNGE + [PodWeaver] + config_plugin = @Author::CCM + [OverridePkgVersion] + + ; GENERATE FILES + [License] + [ReadmeAnyFromPod] + filename = README.md + locaton = root + type = markdown + [ReadmeAnyFromPod] + filename = README + location = build + type = text + [TravisYML] + [Manifest] + [ManifestSkip] + + [MakeMaker] ; override with the "installer" attribute + + ; RELEASE + [CheckChangesHasContent] + [Git::Check] + [TestRelease] + [ConfirmRelease] + [UploadToCPAN] ; disable with the "no_upload" attribute + [Git::Commit] + commit_msg = Release %N %v%t%n%n%c + [Git::CommitBuild] + branch = + release_branch = dist + release_message = Version %v%t + [Git::Tag] + tag_message = Version %v%t%n%n%c + [Git::Push] + push_to = origin master +master:refs/heads/release +dist + remotes_must_exist = 0 + +=head1 SEE ALSO + +=for :list +* L +* L + +=cut + +use warnings; +use strict; + +our $VERSION = '999.999'; # VERSION + +use Dist::Zilla::Util; +use Moose; +use namespace::autoclean; + +=attr installer + +Specify which installer to use, such as: + +=for :list +* C (default) +* C + +=cut + +has installer => ( + is => 'ro', + isa => 'Str', + lazy => 1, + default => sub { shift->payload->{installer} || 'MakeMaker' }, +); + +=attr airplane + +Disable plugins that use the network, and prevent releasing. + +=cut + +has airplane => ( + is => 'ro', + isa => 'Bool', + lazy => 1, + default => sub { $ENV{DZIL_AIRPLANE} // shift->payload->{airplane} // 0 }, +); + +=attr no_upload + +Do not upload to CPAN. + +=cut + +has no_upload => ( + is => 'ro', + isa => 'Bool', + lazy => 1, + default => 0, +); + +=method configure + +Required by L. + +=cut + +sub configure { + my $self = shift; + + my @copy_from_build = qw(LICENSE); + my @network_plugins = qw(Git::Push Test::Pod::No404s UploadToCPAN); + my @gather_exclude = (@copy_from_build, qw(README.md)); + my @gather_prune = qw(dist.ini); + my @no_index = qw(eg share shares t xt); + my @allow_dirty = (@copy_from_build, qw(.travis.yml Changes LICENSE README.md)); + my @git_remotes = qw(github origin); + my @check_files = qw(:InstallModules :ExecFiles :TestFiles :ExtraTestFiles); + + my @plugins = ( + + # VERSION + ['Git::NextVersion'], + ['NextRelease'], + ['ReversionOnRelease' => {prompt => 1}], + + ['ExecDir'], + ['ExtraTests'], + + # GATHER + ['Git::GatherDir' => {exclude_filename => [@gather_exclude]}], + ['PruneCruft'], + ['PruneFiles' => {filename => [@gather_prune]}], + + ['CopyFilesFromBuild' => {copy => [@copy_from_build]}], + + # PREREQS + ['AutoPrereqs'], + -f 'cpanfile' ? ['Prereqs::FromCPANfile'] : (), + ['Prereqs::AuthorDeps'], + + # TESTS + ['MetaTests'], + ['Test::CPAN::Changes'], + ['PodCoverageTests'], + ['PodSyntaxTests'], + ['Test::Pod::No404s'], + ['Test::Compile'], + ['Test::EOL' => {finder => [@check_files]}], + ['Test::NoTabs' => {finder => [@check_files]}], + ['Test::Perl::Critic'], + ['Test::Portability'], + ['Test::CleanNamespaces'], + ['Test::ReportPrereqs'], + + # METADATA + ['Authority' => {do_munging => 0}], + ['MetaJSON'], + ['MetaYAML'], + ['MetaNoIndex' => {directory => [@no_index]}], + ['MetaProvides::Package'], + ['Keywords'], + ['Git::Contributors' => {order_by => 'commits'}], + ['GithubMeta' => {remote => [@git_remotes], issues => 1}], + + # MUNGE + ['PodWeaver' => {config_plugin => '@Author::CCM'}], + ['OverridePkgVersion'], + + # GENERATE FILES + ['License'], + ['ReadmeAnyFromPod' => 'repo readme' => {filename => 'README.md', location => 'root', type => 'markdown'}], + ['ReadmeAnyFromPod' => 'dist readme' => {filename => 'README', location => 'build', type => 'text'}], + ['TravisYML'], + ['Manifest'], + ['ManifestSkip'], + + $self->installer, # e.g. MakeMaker + + # RELEASE + ['CheckChangesHasContent'], + ['Git::Check' => {allow_dirty => [@allow_dirty], untracked_files => 'ignore'}], + ['TestRelease'], + # ['ConfirmRelease'], + $self->no_upload ? ['FakeRelease'] : ['UploadToCPAN'], + ['Git::Commit' => {allow_dirty => [@allow_dirty], commit_msg => 'Release %N %v%t%n%n%c'}], + ['Git::CommitBuild' => {branch => '', release_branch => 'dist', release_message => 'Version %v%t'}], + ['Git::Tag' => {tag_message => 'Version %v%t%n%n%c'}], + ['Git::Push' => {push_to => 'origin master +master:refs/heads/release +dist', remotes_must_exist => 0}], + + ); + + if ($self->airplane) { + my %network_plugins = map { Dist::Zilla::Util->expand_config_package_name($_) => 1 } @network_plugins; + + @plugins = grep { !$network_plugins{Dist::Zilla::Util->expand_config_package_name(ref eq 'ARRAY' ? $_->[0] : $_)} } @plugins; + push @plugins, 'BlockRelease'; + } + + push @plugins, 'ConfirmRelease'; + + $self->add_plugins(@plugins); +} + +with 'Dist::Zilla::Role::PluginBundle::Easy'; +with 'Dist::Zilla::Role::PluginBundle::PluginRemover'; +with 'Dist::Zilla::Role::PluginBundle::Config::Slicer'; + +__PACKAGE__->meta->make_immutable; +1; diff --git a/lib/Pod/Weaver/PluginBundle/Author/CCM.pm b/lib/Pod/Weaver/PluginBundle/Author/CCM.pm new file mode 100644 index 0000000..0ea881b --- /dev/null +++ b/lib/Pod/Weaver/PluginBundle/Author/CCM.pm @@ -0,0 +1,128 @@ +package Pod::Weaver::PluginBundle::Author::CCM; +# ABSTRACT: A plugin bundle for pod woven by CCM + +=head1 SYNOPSIS + + # In your weaver.ini file: + [@Author::CCM] + + # In your dist.ini file: + [PodWeaver] + config_plugin = @Author::CCM + +=head1 DESCRIPTION + +You probably don't want to use this. + +=head1 SEE ALSO + +=for :list +* L +* L + +=head1 CREDITS + +This module was heavily inspired by Karen Etheridge's config. + +=cut + +use warnings; +use strict; + +our $VERSION = '999.999'; # VERSION + +use Pod::Weaver::Config::Assembler; +use namespace::autoclean; + +=method configure + +Returns the configuration in a form similar to what one might use with +L. + +=cut + +sub configure { + return ( + ['-EnsurePod5'], + ['-H1Nester'], + ['-SingleEncoding'], + + ['-Transformer' => List => {transformer => 'List'}], + ['-Transformer' => Verbatim => {transformer => 'Verbatim'}], + + ['Region' => 'header'], + + 'Name', + # ['Badges' => {badge => [qw(perl travis coverage)], formats => 'html, markdown'}], + + 'Version', + + ['Region' => 'prelude'], + + ['Generic' => 'SYNOPSIS'], + ['Generic' => 'DESCRIPTION'], + ['Generic' => 'OVERVIEW'], + ['Collect' => 'ATTRIBUTES' => {command => 'attr'}], + ['Collect' => 'METHODS' => {command => 'method'}], + ['Collect' => 'FUNCTIONS' => {command => 'func'}], + + 'Leftovers', + + ['Region' => 'postlude'], + + 'Bugs', + 'Authors', + 'Contributors', + 'Legal', + + ['Region' => 'footer'], + ); +} + +=method mvp_bundle_config + +Required in order to be a plugin bundle. + +=cut + +sub mvp_bundle_config { + my $self = shift || __PACKAGE__; + + return map { $self->_expand_config($_) } $self->configure; +} + +sub _exp { Pod::Weaver::Config::Assembler->expand_package($_[0]) } + +sub _expand_config { + my $self = shift; + my $spec = shift; + + my ($name, $package, $payload); + + if (!ref $spec) { + ($name, $package, $payload) = ($spec, $spec, {}); + } + elsif (@$spec == 1) { + ($name, $package, $payload) = (@$spec[0,0], {}); + } + elsif (@$spec == 2) { + ($name, $package, $payload) = ref $spec->[1] ? @$spec[0,0,1] : (@$spec[1,0], {}); + } + else { + ($package, $name, $payload) = @$spec; + } + + $name =~ s/^[@=-]//; + $package = _exp($package); + + if ($package eq _exp('Region')) { + $name = $spec->[1]; + $payload = {region_name => $spec->[1], %$payload}; + } + + $name = '@Author::CCM/' . $name if $package ne _exp('Generic') && $package ne _exp('Collect'); + + return [$name => $package => $payload]; +} + +1; diff --git a/t/01-basic.t b/t/01-basic.t new file mode 100644 index 0000000..7963168 --- /dev/null +++ b/t/01-basic.t @@ -0,0 +1,10 @@ +#!perl + +use warnings; +use strict; + +use Test::More tests => 2; + +use_ok('Dist::Zilla::PluginBundle::Author::CCM'); +use_ok('Pod::Weaver::PluginBundle::Author::CCM'); +