.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" 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 "Pithub::Repos::Releases 3pm" .TH Pithub::Repos::Releases 3pm "2023-09-02" "perl v5.36.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" Pithub::Repos::Releases \- Github v3 Repo Releases API .SH "VERSION" .IX Header "VERSION" version 0.01041 .SH "METHODS" .IX Header "METHODS" .SS "assets" .IX Subsection "assets" Provides access to Pithub::Repos::Releases::Assets. .SS "list" .IX Subsection "list" .IP "\(bu" 4 List releases for a repository. .Sp .Vb 1 \& GET /repos/:owner/:repo/releases .Ve .Sp Examples: .Sp .Vb 5 \& my $r = Pithub::Repos::Releases\->new; \& my $result = $r\->get( \& repo => \*(AqPithub\*(Aq, \& user => \*(Aqplu\*(Aq, \& ); .Ve .SS "get" .IX Subsection "get" .IP "\(bu" 4 Get a single release. .Sp .Vb 1 \& GET /repos/:owner/:repo/releases/:id .Ve .Sp Examples: .Sp .Vb 6 \& my $r = Pithub::Repos::Releases\->new; \& my $result = $r\->get( \& repo => \*(AqPithub\*(Aq, \& user => \*(Aqplu\*(Aq, \& release_id => 1, \& ); .Ve .SS "create" .IX Subsection "create" .IP "\(bu" 4 Create a release. .Sp .Vb 1 \& POST /repos/:user/:repo/releases .Ve .Sp Examples: .Sp .Vb 10 \& my $r = Pithub::Repos::Releases\->new; \& my $result = $r\->create( \& user => \*(Aqplu\*(Aq, \& repo => \*(AqPithub\*(Aq, \& data => { \& tag_name => \*(Aqv1.0.0\*(Aq, \& target_commitish => \*(Aqmaster\*(Aq, \& name => \*(Aqv1.0.0\*(Aq, \& body => \*(AqDescription of the release\*(Aq, \& draft => JSON::MaybeXS::false(), # or alternative below \& prerelease => JSON::MaybeXS::false(), # or alternative below \& generate_release_notes => JSON::MaybeXS::false(), # or alternative below \& } \& ); .Ve .Sp Booleans: .Sp Several of the attributes \fBrequire\fR boolean values in the request that is sent to GitHub. Zero (0) and one (1) are integers and will not be encoded correctly in the \s-1JSON\s0 encoded request. .Sp There are numerous options for your call to Pithub::Repos::Releases\->create. .RS 4 .IP "JSON::MaybeXS" 4 .IX Item "JSON::MaybeXS" Add the following to your code before the call to Pithub::Repos::Releases\->create. .Sp .Vb 1 \& require JSON::MaybeXS; .Ve .Sp Then use the following values for the booleans: .Sp .Vb 2 \& JSON::MaybeXS::true() \& JSON::MaybeXS::false() .Ve .IP "Cpanel::JSON::XS" 4 .IX Item "Cpanel::JSON::XS" Add the following to your code before the call to Pithub::Repos::Releases\->create. .Sp .Vb 1 \& require Cpanel::JSON::XS; .Ve .Sp Then use the following values for the booleans: .Sp .Vb 2 \& Cpanel::JSON::XS::true \& Cpanel::JSON::XS::false .Ve .IP "\s-1JSON::PP\s0" 4 .IX Item "JSON::PP" Add the following to your code before the call to Pithub::Repos::Releases\->create. .Sp .Vb 1 \& require JSON::PP; .Ve .Sp Then use the following values for the booleans: .Sp .Vb 2 \& $JSON::PP::true \& $JSON::PP::false .Ve .RE .RS 4 .RE .SS "update" .IX Subsection "update" .IP "\(bu" 4 Edit a release. .Sp .Vb 1 \& PATCH /repos/:user/:repo/releases/:id .Ve .Sp Examples: .Sp .Vb 10 \& my $r = Pithub::Repos::Releases\->new; \& my $result = $r\->update( \& user => \*(Aqplu\*(Aq, \& repo => \*(AqPithub\*(Aq, \& release_id => 1, \& data => { \& tag_name => \*(Aqv1.0.0\*(Aq, \& target_commitish => \*(Aqmaster\*(Aq, \& name => \*(Aqv1.0.0\*(Aq, \& body => \*(AqDescription of the release\*(Aq, \& draft => 0, \& prerelease => 0, \& } \& ); .Ve .SS "delete" .IX Subsection "delete" .IP "\(bu" 4 Delete a release. .Sp .Vb 1 \& DELETE /repos/:user/:repo/releases:id .Ve .Sp Examples: .Sp .Vb 6 \& my $r = Pithub::Repos::Releases\->new; \& my $result = $r\->delete( \& user => \*(Aqplu\*(Aq, \& repo => \*(AqPithub\*(Aq, \& release_id => 1, \& ); .Ve .SH "AUTHOR" .IX Header "AUTHOR" Johannes Plunien .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2011 by Johannes Plunien. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.