### Home Classes Methods

### In Files

- lib/github_api/git_data/commits.rb

### Parent

API

### Methods

- #create
- #find
- #get

### Class/Module Index

Quicksearch

- Github
- Github::API
- Github::Activity
- Github::Activity::Events
- Github::Activity::Notifications
- Github::Activity::Starring
- Github::Activity::Watching
- Github::ApiFactory
- Github::Arguments
- Github::Authorization
- Github::Authorizations
- Github::AutoloadHelper
- Github::Client
- Github::Configuration
- Github::Connection
- Github::Constants
- Github::CoreExt
- Github::CoreExt::OrderedHash
- Github::Descendants
- Github::Emojis
- Github::Error
- Github::Error::BadRequest
- Github::Error::ClientError
- Github::Error::Forbidden
- Github::Error::GithubError
- Github::Error::InternalServerError
- Github::Error::InvalidOptions
- Github::Error::NotAcceptable
- Github::Error::NotFound
- Github::Error::RequiredParams
- Github::Error::ServiceError
- Github::Error::ServiceUnavailable
- Github::Error::Unauthorized
- Github::Error::UnknownValue
- Github::Error::UnprocessableEntity
- Github::Error::Validations
- Github::Gists
- Github::Gists::Comments
- Github::GitData
- Github::GitData::Blobs
- Github::GitData::Commits
- Github::GitData::References
- Github::GitData::Tags
- Github::GitData::Trees
- Github::Gitignore
- Github::Issues
- Github::Issues::Assignees
- Github::Issues::Comments
- Github::Issues::Events
- Github::Issues::Labels
- Github::Issues::Milestones
- Github::Jsonable
- Github::Markdown
- Github::Meta
- Github::MimeType
- Github::Normalizer
- Github::Orgs
- Github::Orgs::Members
- Github::Orgs::Teams
- Github::PageIterator
- Github::PageLinks
- Github::PagedRequest
- Github::Pagination
- Github::ParameterFilter
- Github::ParamsHash
- Github::PullRequests
- Github::PullRequests::Comments
- Github::RateLimit
- Github::Repos
- Github::Repos::Collaborators
- Github::Repos::Comments
- Github::Repos::Commits
- Github::Repos::Contents
- Github::Repos::Downloads
- Github::Repos::Forks
- Github::Repos::Hooks
- Github::Repos::Keys
- Github::Repos::Merging
- Github::Repos::PubSubHubbub
- Github::Repos::Statistics
- Github::Repos::Statuses
- Github::Request
- Github::Request::BasicAuth
- Github::Request::Jsonize
- Github::Request::OAuth2
- Github::Resource
- Github::Response
- Github::Response::Header
- Github::Response::Jsonize
- Github::Response::Mashify
- Github::Response::RaiseError
- Github::Response::Xmlize
- Github::ResponseWrapper
- Github::S3Uploader
- Github::Say
- Github::Scopes
- Github::Search
- Github::Users
- Github::Users::Emails
- Github::Users::Followers
- Github::Users::Keys
- Github::Utils
- Github::Utils::Url
- Github::VERSION
- Github::Validations
- Github::Validations::Format
- Github::Validations::Presence
- Github::Validations::Required
- Github::Validations::Token
- Hash

No matching classes.

# Github::GitData::Commits

### Constants

REQUIRED_COMMIT_PARAMS
VALID_COMMIT_PARAM_NAMES

### Public Instance Methods

create(*args) click to toggle source

Create a commit

# 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

# Examples

    github = Github.new
    github.git_data.commits.create 'user-name', 'repo-name',
      "message": "my commit message",
      "author": {
        "name": "Scott Chacon",
        "email": "schacon@gmail.com",
        "date": "2008-07-09T16:13:30+12:00"
      },
     "parents": [
        "7d1b31e74ee336d15cbd21741bc88a537ed063a0"
      ],
      "tree": "827efc6d56897b048c772eb4087f854f46256132"]

    # File lib/github_api/git_data/commits.rb, line 71
    def create(*args)
      arguments(args, :required => [:user, :repo]) do
        sift VALID_COMMIT_PARAM_NAMES
        assert_required REQUIRED_COMMIT_PARAMS
      end
      params = arguments.params

      post_request("/repos/#{user}/#{repo}/git/commits", params)
    end

find(*args) click to toggle source
Alias for: get
get(*args) click to toggle source

Get a commit

# Examples

    github = Github.new
    github.git_data.commits.get 'user-name', 'repo-name', 'sha'

    commits = Github::Commits.new user: 'user-name', repo: 'repo-name'
    commits.get sha: '...'

    # File lib/github_api/git_data/commits.rb, line 31
    def get(*args)
      arguments(args, :required => [:user, :repo, :sha])
      params = arguments.params

      get_request("/repos/#{user}/#{repo}/git/commits/#{sha}", params)
    end

Also aliased as: find

[Validate]

Generated with the Darkfish Rdoc Generator 2.