The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-GitHub-Repository-v0.0.6
River stage zero No dependents
++
/ App::GitHub::Repository

NAME

App::GitHub::Repository - GitHub client, with some scraping functions

VERSION

This document describes App::GitHub::Repository version 0.0.6

SYNOPSIS

    use App::GitHub::Repository;
    my $repo = App::GitHub::Repository->new('https://github.com/JJ/p5-app-github-repository');

    # These are tests that produce a TAP-parseable output.
    $repo->has_readme( "Has README" );
    $repo->has_file( ".gitignore", "Has .gitignore" );
    $repo->has_milestones( 1, "Correct number of milestones" );
    $repo->issues_well_closed( "Issues closed from a commit" );

DESCRIPTION

A series of sanity checks on GitHub repositories.

INTERFACE

new( $url, $tmp_dir = "/tmp" );

Creates object with repo URL. The directory can't be reused, it will croak if the directory already exists.

issues_well_closed

Checks that issues in the repo have been closed with a commit

has_milestones

Checks that the repo has has a minimum number of milestones open

has_readme

Checks that the README.md file is present in the checked out repo

has_file

Checks that the repository contains a specific file

get_github

Auxiliary function to get a file from GitHub

closes_from_commit( $issue_id )

Checks if an issue has been closed from a commit.

CONFIGURATION AND ENVIRONMENT

App::GitHub::Repository requires curl to be installed.

DEPENDENCIES

The system needs to have curl installed and available.

Use ./Build installdeps to install all dependencies>

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

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.

CAVEATS

Will probably not work from GitHub actions, since they ban scraping from GitHub runners. Use with care in any other environment, for the same reason.

AUTHOR

JJ Merelo <jjmerelo@gmail.com>

LICENCE AND COPYRIGHT

Copyright (c) 2018,2024, 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.