Pithub...ommits(3pm)

πŸ“¦
version 0.01043 Β· 4 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

✨ NAME ✨

Pithub::GitData::Commits β€” it's giving Github v3 Git Data Commits API πŸŽ€ the Perl module that lets you make and fetch commits through GitHub's Git Data API, bestie πŸ’–


🌸 VERSION 🌸

version 0.01043 ✨ (yes she has a version number, she's official)


πŸ’… METHODS πŸ’…

okay so there are literally two of them and they're both iconic, let's go 🫢

🧚 create

  • Create a Commit β€” like, actually make one, no cap πŸ”₯
POST /repos/:user/:repo/git/commits

Parameters: (pay attention bestie, some of these are mandatory)

  • user β€” mandatory string πŸ’œ
  • repo β€” mandatory string πŸ’œ
  • data β€” mandatory hashref, and it has these keys inside it:
    • message β€” mandatory string, the commit message (say something cute in it)
    • tree β€” mandatory string, the SHA of the tree object this commit points to 🌳
    • parents β€” mandatory arrayref of the SHAs of the commits that were the parents of this commit. If it's 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. (so like, if you're lazy it still works, slay ✨)

  • author β€” hashref, having following keys:
    • name β€” string of the name of the author of the commit
    • email β€” string of the email of the author of the commit
    • date β€” timestamp of when this commit was authored
  • committer β€” hashref, having following keys:
    • name β€” string of the name of the committer of the commit
    • email β€” string of the email of the committer of the commit
    • date β€” timestamp of when this commit was committed

Examples: (copy this, it's literally perfect) πŸ“

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: Status: 201 Created πŸŽ‰

{
    "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

  • Get a Commit β€” fetch one that already exists, no biggie πŸ’–
GET /repos/:user/:repo/git/commits/:sha

Parameters:

  • user β€” mandatory string πŸ’œ
  • repo β€” mandatory string πŸ’œ
  • sha β€” mandatory string πŸ’œ

Examples:

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

Response: Status: 200 OK ✨

{
    "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> β€” the main character who wrote this fr fr πŸ’œ


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. (so like, go off, it's free 🫢)


and that's the whole page bestie, no cap ✨

perl v5.40.1 Β· 2025-06-08 Β· Pithub::GitData::Commits(3pm) β€” periodt πŸ’…πŸŒΈπŸ’–

πŸ“¦ where this page comes from