GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PITHUB::GITDATA::COMMITS (3)

.ds Aq ’

NAME

Pithub::GitData::Commits - Github v3 Git Data Commits API

CONTENTS

VERSION

version 0.01033

METHODS

    create

o Create a Commit



    POST /repos/:user/:repo/git/commits



Parameters:
o <B>userB>: mandatory string
o <B>repoB>: mandatory string
o <B>dataB>: mandatory hashref, having following keys:
o <B>messageB>: mandatory string, the commit message
o <B>treeB>: mandatory string, the SHA of the tree object this commit points to
o <B>parentsB>: mandatory arrayref of the SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided, for a merge commit, an array of more than one should be provided points to.

Optional Parameters in the data hashref:

The committer section is optional and will be filled with the author data if omitted. If the author section is omitted, it will be filled in with the authenticated users information and the current date.
o <B>authorB>: hashref, having following keys:
o <B>nameB>: string of the name of the author of the commit
o <B>emailB>: string of the email of the author of the commit
o <B>dateB>: timestamp of when this commit was authored
o <B>committerB>: hashref, having following keys:
o <B>nameB>: string of the name of the committer of the commit
o <B>emailB>: string of the email of the committer of the commit
o <B>dateB>: timestamp of when this commit was committed

Examples:



    my $c = Pithub::GitData::Commits->new;
    my $result = $c->create(
        user => plu,
        repo => Pithub,
        data => {
            author => {
                date  => 2008-07-09T16:13:30+12:00,
                email => schacon@gmail.com,
                name  => Scott Chacon,
            },
            message => my commit message,
            parents => [7d1b31e74ee336d15cbd21741bc88a537ed063a0],
            tree    => 827efc6d56897b048c772eb4087f854f46256132,
        }
    );



Response: <B>Status: 201 CreatedB>



    {
        "sha": "7638417db6d59f3c431d3e1f261cc637155684cd",
        "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
        "author": {
            "date": "2008-07-09T16:13:30+12:00",
            "name": "Scott Chacon",
            "email": "schacon@gmail.com"
        },
        "committer": {
            "date": "2008-07-09T16:13:30+12:00",
            "name": "Scott Chacon",
            "email": "schacon@gmail.com"
        },
        "message": "my commit message",
        "tree": {
            "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132",
            "sha": "827efc6d56897b048c772eb4087f854f46256132"
        },
        "parents": [
        {
            "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0",
            "sha": "7d1b31e74ee336d15cbd21741bc88a537ed063a0"
        }
        ]
    }



    get

o Get a Commit



    GET /repos/:user/:repo/git/commits/:sha



Parameters:
o <B>userB>: mandatory string
o <B>repoB>: mandatory string
o <B>shaB>: mandatory string

Examples:



    my $c = Pithub::GitData::Commits->new;
    my $result = $c->get(
        user => plu,
        repo => Pithub,
        sha  => b7cdea6830e128bc16c2b75efd99842d971666e2,
    );



Response: <B>Status: 200 OKB>



    {
        "sha": "7638417db6d59f3c431d3e1f261cc637155684cd",
        "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
        "author": {
            "date": "2010-04-10T14:10:01-07:00",
            "name": "Scott Chacon",
            "email": "schacon@gmail.com"
        },
        "committer": {
            "date": "2010-04-10T14:10:01-07:00",
            "name": "Scott Chacon",
            "email": "schacon@gmail.com"
        },
        "message": "added readme, because im a good github citizen\n",
        "tree": {
            "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb",
            "sha": "691272480426f78a0138979dd3ce63b77f706feb"
        },
        "parents": [
        {
            "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5",
            "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5"
        }
        ]
    }



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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PITHUB::GITDATA::COMMITS (3) 2016-01-22

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.