NAME
App::GitHub::Repository - [One line description of module's purpose here]
VERSION
This document describes App::GitHub::Repository version 0.0.1
SYNOPSIS
use App::GitHub::Repository;DESCRIPTION
A series of sanity checks on GitHub repositories.
INTERFACE
new
Creates object with repo URL
issues_well_closed
Checks that issues have been closed with a commit
has_milestones
Checks that has a minimum number of milestones open
has_readme
Checks that the readme.md file is present
has_file
Checks that the repository contains a file
get_github
Auxiliary function to get a file from github
closes_from_commit
Checks if an issue has been closed from a commit.
DIAGNOSTICS
CONFIGURATION AND ENVIRONMENT
App::GitHub::Repository requires no configuration files or environment variables.
DEPENDENCIES
git and curl need to be installed in the system before using this.
INCOMPATIBILITIES
None reported.
BUGS AND LIMITATIONS
No bugs have been reported.
Please report any bugs or feature requests to bug-app-github-repository@rt.cpan.org, or through the web interface at http://rt.cpan.org.
AUTHOR
JJ Merelo <jjmerelo@gmail.com>
LICENCE AND COPYRIGHT
Copyright (c) 2018, JJ Merelo <jjmerelo@gmail.com>. All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.
DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "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 SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
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 SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (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 SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.