Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 1.69 KB

File metadata and controls

76 lines (50 loc) · 1.69 KB
title Git Commits | GitHub API

Commits API

  • TOC {:toc}

Get a Commit

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

Response

<%= headers 200 %> <%= json :git_commit %>

Create a Commit

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

Parameters

message : String of the commit message

tree : String of the SHA of the tree object this commit points to

parents : Array 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.

Optional Parameters

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.

author.name : String of the name of the author of the commit

author.email : String of the email of the author of the commit

author.date : Timestamp of when this commit was authored

committer.name : String of the name of the committer of the commit

committer.email : String of the email of the committer of the commit

committer.date : Timestamp of when this commit was committed

Example Input

<%= json "message"=> "my commit message",
"author"=>
{"name" => "Scott Chacon", "email" => "schacon@gmail.com",
"date" => "2008-07-09T16:13:30+12:00"},
"parents"=>["7d1b31e74ee336d15cbd21741bc88a537ed063a0"],
"tree"=>"827efc6d56897b048c772eb4087f854f46256132" %>

Response

<%= headers 201, :Location => "https://api.github.com/git/:user/:repo/commit/:sha" %> <%= json :new_commit %>