Johannes Plunien > Pithub-0.01024 > Pithub::Repos::Statuses

Download:
Pithub-0.01024.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.01024   Source   Latest Release: Pithub-0.01025

NAME ^

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

VERSION ^

version 0.01024

METHODS ^

list

Extra arguments

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

state (required)

The state of the status. Can be one of 'pending', 'success', 'error' or 'failure'.

target_url

This URL will be used to link from the status to some related page, for instance the build result for this specific SHA.

description

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 => {
            status => '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.

syntax highlighting: