Skip to content

Commit

Permalink
updated meta files and get xt test passing
Browse files Browse the repository at this point in the history
  • Loading branch information
xdg committed Apr 11, 2012
1 parent 1b66399 commit 177abbe
Show file tree
Hide file tree
Showing 5 changed files with 263 additions and 0 deletions.
89 changes: 89 additions & 0 deletions META.json
@@ -0,0 +1,89 @@
{
"abstract" : "Ensure Changes has content before releasing",
"author" : [
"David Golden <dagolden@cpan.org>",
"Karen Etheridge <ether@cpan.org>"
],
"dynamic_config" : 0,
"generated_by" : "Dist::Zilla version 4.300009, 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-CheckChangesHasContent",
"no_index" : {
"directory" : [
"t",
"xt",
"examples",
"corpus"
],
"package" : [
"DB"
]
},
"prereqs" : {
"configure" : {
"requires" : {
"ExtUtils::MakeMaker" : "6.30"
}
},
"runtime" : {
"requires" : {
"Dist::Zilla" : "2.100950",
"Dist::Zilla::Plugin::InlineFiles" : "0",
"Dist::Zilla::Role::BeforeRelease" : "0",
"Dist::Zilla::Role::TextTemplate" : "0",
"File::pushd" : "0",
"Moose" : "0.99",
"autodie" : "2.00",
"namespace::autoclean" : "0.09",
"perl" : "5.006",
"strict" : "0",
"warnings" : "0"
}
},
"test" : {
"requires" : {
"Capture::Tiny" : "0",
"Cwd" : "0",
"Dist::Zilla::Tester" : "0",
"File::Find" : "0",
"File::Temp" : "0",
"IO::Scalar" : "0",
"Path::Class" : "0",
"Test::Harness" : "0",
"Test::More" : "0.88",
"Try::Tiny" : "0"
}
}
},
"provides" : {
"Dist::Zilla::Plugin::CheckChangesHasContent" : {
"file" : "lib/Dist/Zilla/Plugin/CheckChangesHasContent.pm",
"version" : "0.004"
},
"Dist::Zilla::Plugin::Test::ChangesHasContent" : {
"file" : "lib/Dist/Zilla/Plugin/Test/ChangesHasContent.pm",
"version" : "0.004"
}
},
"release_status" : "stable",
"resources" : {
"bugtracker" : {
"mailto" : "bug-dist-zilla-plugin-checkchangeshascontent at rt.cpan.org",
"web" : "http://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-CheckChangesHasContent"
},
"homepage" : "https://github.com/dagolden/dist-zilla-plugin-checkchangeshascontent",
"repository" : {
"type" : "git",
"url" : "https://github.com/dagolden/dist-zilla-plugin-checkchangeshascontent.git",
"web" : "https://github.com/dagolden/dist-zilla-plugin-checkchangeshascontent"
}
},
"version" : "0.004"
}

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/

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

=head1 NAME

Dist::Zilla::Plugin::CheckChangesHasContent - Ensure Changes has content before releasing

=head1 VERSION

version 0.004

=head1 SYNOPSIS

# in dist.ini

[CheckChangesHasContent]

=head1 DESCRIPTION

This is a "before release" Dist::Zilla plugin that ensures that your Changes
file actually has some content since the last release. If it doesn't find any,
it will abort the release process.

This can be contrasted to
LE<lt>[Test::ChangesHasContent]E<verbar>Dist::Zilla::Plugin::Test::ChangesHasContentE<gt>, which
generates a test to perform the check.

The algorithm is very naive. It looks for an unindented line starting with
the version to be released. It then looks for any text from that line until
the next unindented line (or the end of the file), ignoring whitespace.

For example, in the file below, algorithm will find "- blah blah blah":

Changes file for Foo-Bar

{{$NEXT}}

- blah blah blah

0.001 Wed May 12 13:49:13 EDT 2010

- the first release

If you had nothing but whitespace between C<<< {{$NEXT}} >>> and C<<< 0.001 >>>,
the release would be halted.

If you name your change log something other than "Changes", you can configure
the name with the C<<< changelog >>> argument:

[CheckChangesHasContent]
changelog = ChangeLog

=for Pod::Coverage before_release

=head1 SEE ALSO

=over

=item *

L<Dist::Zilla::Plugin::Test::ChangesHasContent>

=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-CheckChangesHasContent>.
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-checkchangeshascontent>

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

=head1 AUTHORS

=over 4

=item *

David Golden <dagolden@cpan.org>

=item *

Karen Etheridge <ether@cpan.org>

=back

=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

1 change: 1 addition & 0 deletions dist.ini
Expand Up @@ -5,4 +5,5 @@ license = Apache_2_0
copyright_holder = David Golden

[@DAGOLDEN]
stopwords = unindented

23 changes: 23 additions & 0 deletions perlcritic.rc
@@ -0,0 +1,23 @@
severity = 5
verbose = 8

[Variables::ProhibitPunctuationVars]
allow = $@ $!

[TestingAndDebugging::ProhibitNoStrict]
allow = refs

# Turn these off
[-BuiltinFunctions::ProhibitStringyEval]
[-ControlStructures::ProhibitPostfixControls]
[-ControlStructures::ProhibitUnlessBlocks]
[-Documentation::RequirePodSections]
[-InputOutput::ProhibitInteractiveTest]
[-Miscellanea::RequireRcsKeywords]
[-References::ProhibitDoubleSigils]
[-RegularExpressions::RequireExtendedFormatting]
[-InputOutput::ProhibitTwoArgOpen]

# Turn this on
[Lax::ProhibitStringyEval::ExceptForRequire]

0 comments on commit 177abbe

Please sign in to comment.