NAME

Dist::Zilla::Plugin::CheckIssues - Retrieve count of outstanding RT and github issues for your distribution

VERSION

version 0.011

SYNOPSIS

In your dist.ini:

    [CheckIssues]
    rt = 1              ; default
    github = 1          ; default
    colour = 1          ; default

    [ConfirmRelease]

DESCRIPTION

This is a Dist::Zilla plugin that retrieves the RT and/or github issue and pull request counts for your distribution before release. Place it immediately before [ConfirmRelease] in your dist.ini to give you an opportunity to abort the release if you forgot to fix a bug or merge a pull request.

CONFIGURATION OPTIONS

rt

Checks your distribution's queue at https://rt.cpan.org/. Defaults to true. (You should leave this enabled even if you have your main issue list on github, as sometimes tickets still end up on RT.)

github

Checks the issue list on github for your distribution; does nothing if your distribution is not hosted on github, as listed in your distribution's metadata. Defaults to true.

colour or color

Uses Term::ANSIColor to colour-code the results according to severity. Defaults to true.

repo_url

The URL of the github repository. This is fetched from the resources field in metadata, so it should not normally be specified manually.

FUTURE FEATURES, MAYBE

If I can find the right APIs to call, it would be nice to have a verbose option which fetches the actual titles of the open issues. Advice or patches welcome!

Possibly other issue trackers? Does anyone even use any other issue trackers anymore? :)

ACKNOWLEDGEMENTS

Some code was liberally stolen from Ricardo Signes's codereview tool.

SEE ALSO

• Dist::Zilla::Plugin::MetaResources - manually add resource information (such as git repository) to metadata

• Dist::Zilla::Plugin::GithubMeta - automatically detect and add github repository information to metadata

• Dist::Zilla::Plugin::AutoMetaResources - configuration-based resource metadata provider

SUPPORT

Bugs may be submitted through the RT bug tracker (or bug-Dist-Zilla-Plugin-CheckIssues@rt.cpan.org).

There is also a mailing list available for users of this distribution, at http://dzil.org/#mailing-list.

There is also an irc channel available for users of this distribution, at #distzilla on irc.perl.org.

I am also usually active on irc, as 'ether' at irc.perl.org.

AUTHOR

Karen Etheridge <ether@cpan.org>

COPYRIGHT AND LICENCE

This software is copyright (c) 2014 by Karen Etheridge.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm Dist::Zilla::Plugin::CheckIssues

perl -MCPAN -e shell
install Dist::Zilla::Plugin::CheckIssues