Scroll to navigation

Pithub::Repos::Statuses(3pm) User Contributed Perl Documentation Pithub::Repos::Statuses(3pm)

NAME

Pithub::Repos::Statuses - Github v3 repos / statuses API

VERSION

version 0.01041

METHODS

list

Extra arguments

ref

The SHA, branch, or tag-name to get statuses for

List statuses for a ref

    GET /repos/:user/:repo/statuses/:ref

Examples:

    my $statuses = Pithub::Repos::Statuses->new;
    my $result   = $statuses->list( ref => 'master' );

create

Extra arguments

The state of the status. Can be one of 'pending', 'success', 'error' or 'failure'.
This URL will be used to link from the status to some related page, for instance the build result for this specific SHA.
A short description of the status

Add a status to a SHA.

    POST /repos/:user/:repo/statuses/:sha

Examples:

    my $statuses = Pithub::Repos::Statuses->new;
    my $result   = $statuses->create( user => 'plu', repo => 'Pithub',
        sha => '0123456',
        data => {
            state => 'error',
            description => 'Build failed',
            target_url => 'https://travis-ci.org/some/url/0123456',
        },
    );

AUTHOR

Johannes Plunien <plu@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Johannes Plunien.

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

2023-09-02 perl v5.36.0