DOKK / manpages / debian 11 / libpithub-perl / Pithub::PullRequests.3pm.en
Pithub::PullRequests(3pm) User Contributed Perl Documentation Pithub::PullRequests(3pm)

Pithub::PullRequests - Github v3 Pull Requests API

version 0.01036

Provides access to Pithub::PullRequests::Comments.

Provides access to Pithub::PullRequests::Reviewers.

List commits on a pull request

    GET /repos/:user/:repo/pulls/:id/commits
    

Examples:

    my $p = Pithub::PullRequests->new;
    my $result = $p->commits(
        user            => 'plu',
        repo            => 'Pithub',
        pull_request_id => 1
    );
    

Create a pull request

    POST /repos/:user/:repo/pulls
    

Examples:

    my $p = Pithub::PullRequests->new;
    my $result = $p->create(
        user   => 'plu',
        repo => 'Pithub',
        data   => {
            base  => 'master',
            body  => 'Please pull this in!',
            head  => 'octocat:new-feature',
            title => 'Amazing new feature',
        }
    );
    

List pull requests files

    GET /repos/:user/:repo/pulls/:id/files
    

Examples:

    my $p = Pithub::PullRequests->new;
    my $result = $p->files(
        user            => 'plu',
        repo            => 'Pithub',
        pull_request_id => 1,
    );
    

Get a single pull request

    GET /repos/:user/:repo/pulls/:id
    

Examples:

    my $p = Pithub::PullRequests->new;
    my $result = $p->get(
        user            => 'plu',
        repo            => 'Pithub',
        pull_request_id => 1,
    );
    

Get if a pull request has been merged

    GET /repos/:user/:repo/pulls/:id/merge
    

Examples:

    my $p = Pithub::PullRequests->new;
    my $result = $p->is_merged(
        user            => 'plu',
        repo            => 'Pithub',
        pull_request_id => 1,
    );
    

List pull requests

    GET /repos/:user/:repo/pulls
    

Examples:

    my $p = Pithub::PullRequests->new;
    my $result = $p->list(
        user => 'plu',
        repo => 'Pithub'
    );
    

Merge a pull request

    PUT /repos/:user/:repo/pulls/:id/merge
    

Examples:

    my $p = Pithub::PullRequests->new;
    my $result = $p->merge(
        user            => 'plu',
        repo            => 'Pithub',
        pull_request_id => 1,
    );
    

Update a pull request

    PATCH /repos/:user/:repo/pulls/:id
    

Examples:

    my $p = Pithub::PullRequests->new;
    my $result = $p->update(
        user            => 'plu',
        repo            => 'Pithub',
        pull_request_id => 1,
        data            => {
            base  => 'master',
            body  => 'Please pull this in!',
            head  => 'octocat:new-feature',
            title => 'Amazing new feature',
        }
    );
    

Johannes Plunien <plu@cpan.org>

This software is copyright (c) 2011-2019 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.

2021-02-15 perl v5.32.1