Pithub::GitData::References - Github v3 Git Data References API
version 0.01002
Create a Reference
POST /repos/:user/:repo/git/refs
Examples:
$result = $p->git_data->references->create( user => 'plu', repo => 'Pithub', data => { ref => 'refs/heads/master', sha => '827efc6d56897b048c772eb4087f854f46256132' . } );
Parameters in data hashref:
data
ref: String of the name of the fully qualified reference (ie: refs/heads/master). If it doesn’t start with 'refs' and have at least two slashes, it will be rejected.
sha: String of the SHA1 value to set this reference to
Get a Reference
GET /repos/:user/:repo/git/refs/:ref
$result = $p->git_data->references->get( user => 'plu', repo => 'Pithub', ref => 'heads/master' );
The key ref must be formatted as heads/branch, not just branch. For example, the call to get the data for a branch named sc/featureA > would be: heads/sc/featureA
heads/branch
branch
sc/featureA > would be: heads/sc/featureA
heads/sc/featureA
Get all References
GET /repos/:user/:repo/git/refs
This will return an array of all the references on the system, including things like notes and stashes if they exist on the server. Anything in the namespace, not just heads and tags, though that would be the most common.
$result = $p->git_data->references->list( user => 'plu', repo => 'Pithub', );
You can also request a sub-namespace. For example, to get all the tag references, you can call:
GET /repos/:user/:repo/git/refs/tags
$result = $p->git_data->references->list( user => 'plu', repo => 'Pithub', ref => 'tags', );
Update a Reference
PATCH /repos/:user/:repo/git/refs/:ref
$result = $p->git_data->references->update( user => 'plu', repo => 'Pithub', ref => 'tags/v1.0', data => { force => 1, sha => 'aa218f56b14c9653891f9e74264a383fa43fefbd', } );
force: Boolean indicating whether to force the update or to make sure the update is a fast-forward update. The default is false, so leaving this out or setting it to false will make sure you’re not overwriting work.
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.
2 POD Errors
The following errors were encountered while parsing the POD:
Non-ASCII character seen before =encoding in 'doesn’t'. Assuming UTF-8
Unterminated C< ... > sequence
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.