table of contents
Pithub::Repos::Commits(3pm) | User Contributed Perl Documentation | Pithub::Repos::Commits(3pm) |
NAME¶
Pithub::Repos::Commits - Github v3 Repo Commits API
VERSION¶
version 0.01041
METHODS¶
compare¶
- •
- Compare two commits
GET /repos/:user/:repo/compare/:base...:head
Examples:
my $c = Pithub::Repos::Commits->new; my $result = $c->compare( user => 'plu', repo => 'Pithub', base => 'v0.01008', head => ' master ', );
create_comment¶
- •
- Create a commit comment
POST /repos/:user/:repo/commits/:sha/comments
Examples:
my $c = Pithub::Repos::Commits->new; my $result = $c->create_comment( user => 'plu', repo => 'Pithub', sha => 'df21b2660fb6', data => { body => 'some comment' }, );
delete_comment¶
- •
- Delete a commit comment
DELETE /repos/:user/:repo/comments/:id
Examples:
my $c = Pithub::Repos::Commits->new; my $result = $c->delete_comment( user => 'plu', repo => 'Pithub', comment_id => 1, );
get¶
- •
- Get a single commit
GET /repos/:user/:repo/commits/:sha
Examples:
my $c = Pithub::Repos::Commits->new; my $result = $c->get( user => 'plu', repo => 'Pithub', sha => 'df21b2660fb6', );
get_comment¶
- •
- Get a single commit comment
GET /repos/:user/:repo/comments/:id
Examples:
my $c = Pithub::Repos::Commits->new; my $result = $c->get_comment( user => 'plu', repo => 'Pithub', comment_id => 1, );
list¶
- •
- List commits on a repository
GET /repos/:user/:repo/commits
Examples:
my $c = Pithub::Repos::Commits->new; my $result = $c->list( user => 'plu', repo => 'Pithub', );
list_comments¶
- List commit comments for a repository
Commit Comments leverage these custom mime types. You can read more about the use of mimes types in the API here. See also: <http://developer.github.com/v3/mimes/>.
GET /repos/:user/:repo/comments
Examples:
my $c = Pithub::Repos::Commits->new; my $result = $c->list_comments( user => 'plu', repo => 'Pithub', );
- List comments for a single commit
GET /repos/:user/:repo/commits/:sha/comments
Examples:
my $c = Pithub::Repos::Commits->new; my $result = $c->list_comments( user => 'plu', repo => 'Pithub', sha => 'df21b2660fb6', );
update_comment¶
- •
- Update a commit comment
PATCH /repos/:user/:repo/comments/:id
Examples:
my $c = Pithub::Repos::Commits->new; my $result = $c->update_comment( user => 'plu', repo => 'Pithub', comment_id => 1, data => { body => 'updated comment' }, );
AUTHOR¶
Johannes Plunien <plu@cpan.org>
COPYRIGHT AND LICENSE¶
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.
2023-09-02 | perl v5.36.0 |