.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Net::GitHub::V3::PullRequests 3pm" .TH Net::GitHub::V3::PullRequests 3pm "2022-10-08" "perl v5.34.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Net::GitHub::V3::PullRequests \- GitHub Pull Requests API .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Net::GitHub::V3; \& \& my $gh = Net::GitHub::V3\->new; # read L to set right authentication info \& my $pull_request = $gh\->pull_request; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBTo ease the keyboard, we provied two ways to call any method which starts with :user/:repo\fR .PP 1. \s-1SET\s0 user/repos before call methods below .PP .Vb 3 \& $gh\->set_default_user_repo(\*(Aqfayland\*(Aq, \*(Aqperl\-net\-github\*(Aq); # take effects for all $gh\-> \& $pull_request\->set_default_user_repo(\*(Aqfayland\*(Aq, \*(Aqperl\-net\-github\*(Aq); # only take effect to $gh\->pull_request \& my @pulls = $pull_request\->pulls(); .Ve .PP 2. If it is just for once, we can pass :user, :repo before any arguments .PP .Vb 1 \& my @pulls = $pull_request\->pulls($user, $repo); .Ve .SS "\s-1METHODS\s0" .IX Subsection "METHODS" \fIPull Requets\fR .IX Subsection "Pull Requets" .PP .IP "pulls" 4 .IX Item "pulls" .Vb 3 \& my @pulls = $pull_request\->pulls(); \& my @pulls = $pull_request\->pulls( { state => \*(Aqopen\*(Aq } ); \& while (my $pr = $pull_request\->next_pull( { state => \*(Aqopen\*(Aq } )) { ...; } .Ve .IP "pull" 4 .IX Item "pull" .Vb 1 \& my $pull = $pull_request\->pull($pull_number); .Ve .IP "create_pull" 4 .IX Item "create_pull" .PD 0 .IP "update_pull" 4 .IX Item "update_pull" .PD .Vb 7 \& my $pull = $pull_request\->create_pull( { \& "title" => "Amazing new feature", \& "body" => "Please pull this in!", \& "head" => "octocat:new\-feature", \& "base" => "master" \& } ); \& my $pull = $pull_request\->update_pull( $pull_number, $new_pull_data ); .Ve .IP "commits" 4 .IX Item "commits" .PD 0 .IP "files" 4 .IX Item "files" .PD .Vb 4 \& my @commits = $pull_request\->commits($pull_number); \& my @files = $pull_request\->files($pull_number); \& while (my $commit = $pull_request\->next_commit($pull_number)) { ...; } \& while (my $file = $pull_request\->next_file($pull_number)) { ...; } .Ve .IP "is_merged" 4 .IX Item "is_merged" .PD 0 .IP "merge" 4 .IX Item "merge" .PD .Vb 2 \& my $is_merged = $pull_request\->is_merged($pull_number); \& my $result = $pull_request\->merge($pull_number); .Ve .PP \fIPull Request Comments \s-1API\s0\fR .IX Subsection "Pull Request Comments API" .PP .IP "comments" 4 .IX Item "comments" .PD 0 .IP "comment" 4 .IX Item "comment" .IP "create_comment" 4 .IX Item "create_comment" .IP "update_comment" 4 .IX Item "update_comment" .IP "delete_comment" 4 .IX Item "delete_comment" .PD .Vb 10 \& my @comments = $pull_request\->comments($pull_number); \& while (my $comment = $pull_request\->next_comment($pull_number)) { ...; } \& my $comment = $pull_request\->comment($comment_id); \& my $comment = $pull_request\->create_comment($pull_number, { \& "body" => "a new comment", \& commit_id => \*(Aq586fe4be94c32248043b344e99fa15c72b40d1c2\*(Aq, \& path => \*(Aqtest\*(Aq, \& position => 1, \& }); \& my $comment = $pull_request\->update_comment($comment_id, { \& "body" => "Nice change" \& }); \& my $st = $pull_request\->delete_comment($comment_id); .Ve .PP \fIPull Request Reviews \s-1API\s0\fR .IX Subsection "Pull Request Reviews API" .PP .IP "reviews" 4 .IX Item "reviews" .PD 0 .IP "review" 4 .IX Item "review" .IP "create_review" 4 .IX Item "create_review" .IP "update_review" 4 .IX Item "update_review" .IP "delete_review" 4 .IX Item "delete_review" .PD .Vb 12 \& my @reviews = $pull_request\->reviews($pull_number); \& while (my $review = $pull_request\->next_review($pull_number)) { ...; } \& my $review = $pull_request\->review($review_id); \& my $review = $pull_request\->create_review($pull_number, { \& "body" => "a new review", \& commit_id => \*(Aq586fe4be94c32248043b344e99fa15c72b40d1c2\*(Aq, \& event => \*(AqAPPROVE\*(Aq, \& }); \& my $review = $pull_request\->update_review($review_id, { \& "body" => "Nice change" \& }); \& my $st = $pull_request\->delete_review($review_id); .Ve .PP \fIPull Request Review \s-1API\s0\fR .IX Subsection "Pull Request Review API" .PP .IP "reviewers" 4 .IX Item "reviewers" .PD 0 .IP "add_reviewers" 4 .IX Item "add_reviewers" .IP "delete_reviewers" 4 .IX Item "delete_reviewers" .PD .Vb 9 \& my @reviewers = $pull_request\->reviewers($pull_number); \& my $result = $pull_request\->add_reviewers($pull_number, { \& reviewers => [$user1, $user2], \& team_reviewers => [$team1], \& ); \& my $result = $pull_request\->delete_reviewers($pull_number, { \& reviewers => [$user1, $user2], \& team_reviewers => [$team1], \& ); .Ve .SH "AUTHOR & COPYRIGHT & LICENSE" .IX Header "AUTHOR & COPYRIGHT & LICENSE" Refer Net::GitHub