Pithub::Repos::Releases - Github v3 Repo Releases API
version 0.01041
Provides access to Pithub::Repos::Releases::Assets.
List releases for a repository.
GET /repos/:owner/:repo/releases
Examples:
my $r = Pithub::Repos::Releases->new; my $result = $r->get( repo => 'Pithub', user => 'plu', );
Get a single release.
GET /repos/:owner/:repo/releases/:id
my $r = Pithub::Repos::Releases->new; my $result = $r->get( repo => 'Pithub', user => 'plu', release_id => 1, );
Create a release.
POST /repos/:user/:repo/releases
my $r = Pithub::Repos::Releases->new; my $result = $r->create( user => 'plu', repo => 'Pithub', data => { tag_name => 'v1.0.0', target_commitish => 'master', name => 'v1.0.0', body => 'Description of the release', draft => JSON::MaybeXS::false(), # or alternative below prerelease => JSON::MaybeXS::false(), # or alternative below generate_release_notes => JSON::MaybeXS::false(), # or alternative below } );
Booleans:
Several of the attributes require 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 JSON encoded request.
There are numerous options for your call to Pithub::Repos::Releases->create.
Add the following to your code before the call to Pithub::Repos::Releases->create.
require JSON::MaybeXS;
Then use the following values for the booleans:
JSON::MaybeXS::true() JSON::MaybeXS::false()
require Cpanel::JSON::XS;
Cpanel::JSON::XS::true Cpanel::JSON::XS::false
require JSON::PP;
$JSON::PP::true $JSON::PP::false
Edit a release.
PATCH /repos/:user/:repo/releases/:id
my $r = Pithub::Repos::Releases->new; my $result = $r->update( user => 'plu', repo => 'Pithub', release_id => 1, data => { tag_name => 'v1.0.0', target_commitish => 'master', name => 'v1.0.0', body => 'Description of the release', draft => 0, prerelease => 0, } );
Delete a release.
DELETE /repos/:user/:repo/releases:id
my $r = Pithub::Repos::Releases->new; my $result = $r->delete( user => 'plu', repo => 'Pithub', release_id => 1, );
Johannes Plunien <plu@cpan.org>
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.
To install Pithub, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pithub
CPAN shell
perl -MCPAN -e shell install Pithub
For more information on module installation, please visit the detailed CPAN module installation guide.