Permalink
Browse files

Add README's and META to repo

  • Loading branch information...
xdg committed Sep 23, 2011
1 parent d946d37 commit b5eb2c5826c809790e55d3d8a61b20001afc4809
Showing with 357 additions and 0 deletions.
  1. +106 −0 META.json
  2. +50 −0 README.PATCHING
  3. +201 −0 README.pod
View
106 META.json
@@ -0,0 +1,106 @@
+{
+ "abstract" : "Dist::Zilla configuration the way DAGOLDEN does it",
+ "author" : [
+ "David Golden <dagolden@cpan.org>"
+ ],
+ "dynamic_config" : 0,
+ "generated_by" : "Dist::Zilla version 4.300002, CPAN::Meta::Converter version 2.112580",
+ "license" : [
+ "apache_2_0"
+ ],
+ "meta-spec" : {
+ "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
+ "version" : "2"
+ },
+ "name" : "Dist-Zilla-PluginBundle-DAGOLDEN",
+ "no_index" : {
+ "directory" : [
+ "t",
+ "xt",
+ "examples",
+ "corpus"
+ ],
+ "package" : [
+ "DB"
+ ]
+ },
+ "prereqs" : {
+ "configure" : {
+ "requires" : {
+ "ExtUtils::MakeMaker" : "6.30"
+ }
+ },
+ "runtime" : {
+ "requires" : {
+ "Dist::Zilla" : "4.3",
+ "Dist::Zilla::Plugin::Bugtracker" : "1.102670",
+ "Dist::Zilla::Plugin::CheckChangesHasContent" : 0,
+ "Dist::Zilla::Plugin::CheckExtraTests" : 0,
+ "Dist::Zilla::Plugin::CheckPrereqsIndexed" : "0.002",
+ "Dist::Zilla::Plugin::CompileTests" : 0,
+ "Dist::Zilla::Plugin::CopyFilesFromBuild" : 0,
+ "Dist::Zilla::Plugin::Git::NextVersion" : 0,
+ "Dist::Zilla::Plugin::GithubMeta" : "0.10",
+ "Dist::Zilla::Plugin::InsertCopyright" : "0.001",
+ "Dist::Zilla::Plugin::MetaNoIndex" : 0,
+ "Dist::Zilla::Plugin::MetaProvides::Package" : "1.11044404",
+ "Dist::Zilla::Plugin::MinimumPerl" : 0,
+ "Dist::Zilla::Plugin::OurPkgVersion" : "0.001008",
+ "Dist::Zilla::Plugin::PodSpellingTests" : 0,
+ "Dist::Zilla::Plugin::PodWeaver" : 0,
+ "Dist::Zilla::Plugin::PortabilityTests" : 0,
+ "Dist::Zilla::Plugin::ReadmeAnyFromPod" : 0,
+ "Dist::Zilla::Plugin::ReadmeFromPod" : 0,
+ "Dist::Zilla::Plugin::TaskWeaver" : "0.101620",
+ "Dist::Zilla::Plugin::Test::Version" : 0,
+ "Dist::Zilla::PluginBundle::Filter" : 0,
+ "Dist::Zilla::PluginBundle::Git" : 0,
+ "Dist::Zilla::Role::PluginBundle::Easy" : 0,
+ "Moose" : "0.99",
+ "Moose::Autobox" : 0,
+ "Pod::Elemental::Transformer::List" : "0.101620",
+ "Pod::Weaver::Config::Assembler" : 0,
+ "Pod::Weaver::Plugin::WikiDoc" : 0,
+ "Pod::Weaver::Section::Support" : "1.001",
+ "autodie" : "2.00",
+ "namespace::autoclean" : "0.09",
+ "perl" : "5.006",
+ "strict" : 0,
+ "warnings" : 0
+ }
+ },
+ "test" : {
+ "requires" : {
+ "File::Find" : 0,
+ "File::Temp" : 0,
+ "Test::Exception" : "0.29",
+ "Test::More" : "0.88"
+ }
+ }
+ },
+ "provides" : {
+ "Dist::Zilla::PluginBundle::DAGOLDEN" : {
+ "file" : "lib/Dist/Zilla/PluginBundle/DAGOLDEN.pm",
+ "version" : "0.020"
+ },
+ "Pod::Weaver::PluginBundle::DAGOLDEN" : {
+ "file" : "lib/Pod/Weaver/PluginBundle/DAGOLDEN.pm",
+ "version" : "0.020"
+ }
+ },
+ "release_status" : "stable",
+ "resources" : {
+ "bugtracker" : {
+ "mailto" : "bug-dist-zilla-pluginbundle-dagolden at rt.cpan.org",
+ "web" : "http://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-PluginBundle-DAGOLDEN"
+ },
+ "homepage" : "https://github.com/dagolden/dist-zilla-pluginbundle-dagolden",
+ "repository" : {
+ "type" : "git",
+ "url" : "https://github.com/dagolden/dist-zilla-pluginbundle-dagolden.git",
+ "web" : "https://github.com/dagolden/dist-zilla-pluginbundle-dagolden"
+ }
+ },
+ "version" : "0.020"
+}
+
View
@@ -0,0 +1,50 @@
+README.PATCHING
+
+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 (e.g. Makefile.PL).
+
+However, you can run tests directly using the 'prove' tool:
+
+ $ prove -l
+ $ prove -lv t/some_test_file.t
+
+For most distributions, 'prove' is entirely sufficent for you to test any
+patches you have.
+
+You may need to satisfy some dependencies. See the included META.json
+file for a list. If you install App::mymeta_requires from CPAN, it's easy
+to satisfy any that you are missing by piping the output to your favorite
+CPAN client:
+
+ $ mymeta-requires | cpanm
+ $ cpan `mymeta-requires`
+
+Likewise, much of the documentation Pod is generated at release time.
+Depending on the distribution, some documentation may be written in a Pod
+dialect called WikiDoc. (See Pod::WikiDoc on CPAN.) 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.
+
+Dist::Zilla is a very powerful authoring tool, but requires a number of
+author-specific plugins. If you would like to use it for contributing,
+install it from CPAN, then run one of the following commands, depending on
+your CPAN client:
+
+ $ 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/
+
View
@@ -0,0 +1,201 @@
+=pod
+
+=head1 NAME
+
+Dist::Zilla::PluginBundle::DAGOLDEN - Dist::Zilla configuration the way DAGOLDEN does it
+
+=head1 VERSION
+
+version 0.020
+
+=head1 SYNOPSIS
+
+ # in dist.ini
+ [@DAGOLDEN]
+
+=head1 DESCRIPTION
+
+This is a L<Dist::Zilla> PluginBundle. It is roughly equivalent to the
+following dist.ini:
+
+ ; version provider
+ [Git::NextVersion] ; get version from last release tag
+ version_regexp = ^release-(.+)$
+
+ ; choose files to include
+ [GatherDir] ; everything under top dir
+ [PruneCruft] ; default stuff to skip
+ [ManifestSkip] ; if -f MANIFEST.SKIP, skip those, too
+
+ ; file modifications
+ [OurPkgVersion] ; add $VERSION = ... to all files
+ [InsertCopyright ; add copyright at "# COPYRIGHT"
+ [PodWeaver] ; generate Pod
+ config_plugin = @DAGOLDEN ; my own plugin allows Pod::WikiDoc
+
+ ; generated files
+ [License] ; boilerplate license
+ [ReadmeFromPod] ; from Pod (runs after PodWeaver)
+
+ ; t tests
+ [CompileTests] ; make sure .pm files all compile
+ fake_home = 1 ; fakes $ENV{HOME} just in case
+
+ ; xt tests
+ [MetaTests] ; xt/release/meta-yaml.t
+ [PodSyntaxTests] ; xt/release/pod-syntax.t
+ [PodCoverageTests] ; xt/release/pod-coverage.t
+ [PortabilityTests] ; xt/release/portability.t (of file name)
+ [Test::Version] ; xt/release/test-version.t
+
+ ; metadata
+ [AutoPrereqs] ; find prereqs from code
+ [MinimumPerl] ; determine minimum perl version
+ [GithubMeta]
+
+ [MetaNoIndex] ; sets 'no_index' in META
+ directory = t
+ directory = xt
+ directory = examples
+ directory = corpus
+ package = DB ; just in case
+
+ [Bugtracker] ; defaults to RT
+
+ [MetaProvides::Package] ; add 'provides' to META files
+ meta_noindex = 1 ; respect prior no_index directives
+
+ [MetaYAML] ; generate META.yml (v1.4)
+ [MetaJSON] ; generate META.json (v2)
+
+ ; build system
+ [ExecDir] ; include 'bin/*' as executables
+ [ShareDir] ; include 'share/' for File::ShareDir
+ [MakeMaker] ; create Makefile.PL
+
+ ; manifest (after all generated files)
+ [Manifest] ; create MANIFEST
+
+ ; before release
+ [Git::Check] ; ensure all files checked in
+ [CheckPrereqsIndexed] ; ensure prereqs are on CPAN
+ [CheckChangesHasContent] ; ensure Changes has been updated
+ [CheckExtraTests] ; ensure xt/ tests pass
+ [TestRelease] ; ensure t/ tests pass
+ [ConfirmRelease] ; prompt before uploading
+
+ ; releaser
+ [UploadToCPAN] ; uploads to CPAN
+
+ ; after release
+ [Git::Commit / Commit_Dirty_Files] ; commit Changes (as released)
+
+ [Git::Tag] ; tag repo with custom tag
+ tag_format = release-%v
+
+ ; NextRelease acts *during* pre-release to write $VERSION and
+ ; timestamp to Changes and *after* release to add a new {{$NEXT}}
+ ; section, so to act at the right time after release, it must actually
+ ; come after Commit_Dirty_Files but before Commit_Changes in the
+ ; dist.ini. It will still act during pre-release as usual
+
+ [NextRelease]
+
+ [Git::Commit / Commit_Changes] ; commit Changes (for new dev)
+
+ [Git::Push] ; push repo to remote
+ push_to = origin
+
+=for stopwords autoprereq dagolden fakerelease pluginbundle podweaver
+taskweaver uploadtocpan dist ini
+
+=for Pod::Coverage configure
+
+=head1 USAGE
+
+To use this PluginBundle, just add it to your dist.ini. You can provide
+the following options:
+
+=over
+
+=item *
+
+C<<< is_task >>> -- this indicates whether TaskWeaver or PodWeaver should be used.
+Default is 0.
+
+=item *
+
+C<<< auto_prereq >>> -- this indicates whether AutoPrereq should be used or not.
+Default is 1.
+
+=item *
+
+C<<< tag_format >>> -- given to C<<< Git::Tag >>>. Default is 'release-%v' to be more
+robust than just the version number when parsing versions for
+C<<< Git::NextVersion >>>
+
+=item *
+
+C<<< version_regexp >>> -- given to C<<< Git::NextVersion >>>. Default
+is '^release-(.+)$'
+
+=item *
+
+C<<< fake_release >>> -- swaps FakeRelease for UploadToCPAN. Mostly useful for
+testing a dist.ini without risking a real release.
+
+=item *
+
+C<<< weaver_config >>> -- specifies a Pod::Weaver bundle. Defaults to @DAGOLDEN.
+
+=back
+
+=head1 SEE ALSO
+
+=over
+
+=item *
+
+L<Dist::Zilla>
+
+=item *
+
+L<Dist::Zilla::Plugin::PodWeaver>
+
+=item *
+
+L<Dist::Zilla::Plugin::TaskWeaver>
+
+=back
+
+=for :stopwords cpan testmatrix url annocpan anno bugtracker rt cpants kwalitee diff irc mailto metadata placeholders
+
+=head1 SUPPORT
+
+=head2 Bugs / Feature Requests
+
+Please report any bugs or feature requests by email to C<bug-dist-zilla-pluginbundle-dagolden at rt.cpan.org>, or through
+the web interface at L<http://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-PluginBundle-DAGOLDEN>. You will be automatically notified of any
+progress on the request by the system.
+
+=head2 Source Code
+
+This is open source software. The code repository is available for
+public review and contribution under the terms of the license.
+
+L<https://github.com/dagolden/dist-zilla-pluginbundle-dagolden>
+
+ git clone https://github.com/dagolden/dist-zilla-pluginbundle-dagolden.git
+
+=head1 AUTHOR
+
+David Golden <dagolden@cpan.org>
+
+=head1 COPYRIGHT AND LICENSE
+
+This software is Copyright (c) 2011 by David Golden.
+
+This is free software, licensed under:
+
+ The Apache License, Version 2.0, January 2004
+

0 comments on commit b5eb2c5

Please sign in to comment.