Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Pithub::PullRequests(3User Contributed Perl DocumentatiPithub::PullRequests(3)

NAME
       Pithub::PullRequests - Github v3	Pull Requests API

VERSION
       version 0.01035

METHODS
   comments
       Provides	access to Pithub::PullRequests::Comments.

   commits
       o   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
       o   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',
		   }
	       );

   files
       o   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
       o   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,
	       );

   is_merged
       o   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
       o   List	pull requests

	       GET /repos/:user/:repo/pulls

	   Examples:

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

   merge
       o   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
       o   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',
		   }
	       );

AUTHOR
       Johannes	Plunien	<plu@cpan.org>

COPYRIGHT AND LICENSE
       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.

perl v5.32.0			  2019-11-23	       Pithub::PullRequests(3)

NAME | VERSION | METHODS | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Pithub::PullRequests&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help