Skip to content

Commit

Permalink
add README files and META
Browse files Browse the repository at this point in the history
  • Loading branch information
xdg committed May 3, 2012
1 parent 3ee9265 commit 013a36a
Show file tree
Hide file tree
Showing 3 changed files with 195 additions and 0 deletions.
89 changes: 89 additions & 0 deletions META.json
@@ -0,0 +1,89 @@
{
"abstract" : "check xt tests before release",
"author" : [
"David Golden <dagolden@cpan.org>"
],
"dynamic_config" : 0,
"generated_by" : "Dist::Zilla version 4.300015, CPAN::Meta::Converter version 2.120630",
"license" : [
"apache_2_0"
],
"meta-spec" : {
"url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
"version" : "2"
},
"name" : "Dist-Zilla-Plugin-CheckExtraTests",
"no_index" : {
"directory" : [
"t",
"xt",
"examples",
"corpus"
],
"package" : [
"DB"
]
},
"prereqs" : {
"configure" : {
"requires" : {
"ExtUtils::MakeMaker" : "6.30"
}
},
"runtime" : {
"requires" : {
"App::Prove" : "3.00",
"Dist::Zilla" : "2.100950",
"Dist::Zilla::App" : "0",
"Dist::Zilla::Role::BeforeRelease" : "0",
"File::Temp" : "0",
"File::pushd" : "0",
"Moose" : "0.99",
"Moose::Autobox" : "0",
"Path::Class" : "0",
"Path::Class::Rule" : "0",
"namespace::autoclean" : "0.09",
"perl" : "5.006",
"strict" : "0",
"warnings" : "0"
}
},
"test" : {
"requires" : {
"Capture::Tiny" : "0",
"Dist::Zilla::App::Tester" : "0",
"Dist::Zilla::Tester" : "0",
"File::Find" : "0",
"Params::Util" : "0",
"Sub::Exporter" : "0",
"Test::More" : "0.88",
"Try::Tiny" : "0"
}
}
},
"provides" : {
"Dist::Zilla::App::Command::xtest" : {
"file" : "lib/Dist/Zilla/App/Command/xtest.pm",
"version" : "0.005"
},
"Dist::Zilla::Plugin::CheckExtraTests" : {
"file" : "lib/Dist/Zilla/Plugin/CheckExtraTests.pm",
"version" : "0.005"
}
},
"release_status" : "stable",
"resources" : {
"bugtracker" : {
"mailto" : "bug-dist-zilla-plugin-checkextratests at rt.cpan.org",
"web" : "http://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-CheckExtraTests"
},
"homepage" : "https://github.com/dagolden/dist-zilla-plugin-checkextratests",
"repository" : {
"type" : "git",
"url" : "https://github.com/dagolden/dist-zilla-plugin-checkextratests.git",
"web" : "https://github.com/dagolden/dist-zilla-plugin-checkextratests"
}
},
"version" : "0.005"
}

42 changes: 42 additions & 0 deletions README.PATCHING
@@ -0,0 +1,42 @@
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.

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/

64 changes: 64 additions & 0 deletions README.pod
@@ -0,0 +1,64 @@
=pod

=head1 NAME

Dist::Zilla::Plugin::CheckExtraTests - check xt tests before release

=head1 VERSION

version 0.005

=head1 SYNOPSIS

In your dist.ini:

[CheckExtraTests]

=head1 DESCRIPTION

Runs all xt tests before release. Dies if any fail. Sets RELEASE_TESTING,
but not AUTHOR_TESTING.

=for Pod::Coverage::TrustPod before_release

=head1 SEE ALSO

=over

=item *

L<Dist::Zilla>

=back

=for :stopwords cpan testmatrix url annocpan anno bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan

=head1 SUPPORT

=head2 Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker
at L<http://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-CheckExtraTests>.
You will be notified automatically of any progress on your issue.

=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-plugin-checkextratests>

git clone https://github.com/dagolden/dist-zilla-plugin-checkextratests.git

=head1 AUTHOR

David Golden <dagolden@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2012 by David Golden.

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

0 comments on commit 013a36a

Please sign in to comment.