Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 2.05 KB

File metadata and controls

63 lines (43 loc) · 2.05 KB
title Git Commits | GitHub API

Commits

  • TOC {:toc}

Get a Commit

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

Response

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

Create a Commit

POST /repos/:owner/:repo/git/commits

Parameters

Name Type Description
message string Required. The commit message
tree string Required. The SHA of the tree object this commit points to
parents array of strings Required. 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

You can provide an additional commiter parameter, which is a hash containing information about the committer. Or, you can provide an author parameter, which is a hash containing information about the author.

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 user's information and the current date.

Both the author and commiter parameters have the same keys:

Name Type Description
name string The name of the author (or commiter) of the commit
email string The email of the author (or commiter) of the commit
date string Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

Example Input

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

Response

<%= headers 201, :Location => "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd" %> <%= json :new_commit %>