class Github::GitData::Trees

Constants

VALID_TREE_PARAM_NAMES
VALID_TREE_PARAM_VALUES

Public Instance Methods

create(*args) click to toggle source

Create a tree

The tree creation API will take nested entries as well. If both a tree and a nested path modifying that tree are specified, it will overwrite the contents of that tree with the new path contents and write a new tree out.

Parameters

  • :base_tree - optional string of the SHA1 of the tree you want to update with new data

  • :tree - array of hash objects(of :path, :mode, :type and sha)

  • tree.path

    String of the file referenced in the tree

  • tree.mode

    String of the file mode - one of 100644 for file(blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit) or 120000 for a blob that specifies the path of a symlink

  • tree.type

    String of blob, tree, commit

  • tree.sha

    String of SHA1 checksum ID of the object in the tree

  • tree.content

    String of content you want this file to have - GitHub will write this blob out and use the SHA for this entry. Use either this or tree.sha

Examples

github = Github.new
github.git_data.trees.create 'user-name', 'repo-name',
  "tree" => [
    {
      "path" => "file.rb",
      "mode" => "100644",
      "type" => "blob",
      "sha" => "44b4fc6d56897b048c772eb4087f854f46256132"
    },
    ...
  ]
# File lib/github_api/git_data/trees.rb, line 80
def create(*args)
  arguments(args, :required => [:user, :repo]) do
    assert_required %w[ tree ]
    sift VALID_TREE_PARAM_NAMES, 'tree', { recursive: true }
    assert_values VALID_TREE_PARAM_VALUES, 'tree'
  end

  post_request("/repos/#{user}/#{repo}/git/trees", arguments.params)
end
find(*args)
Alias for: get
get(*args) { |el| ... } click to toggle source

Get a tree

Examples

github = Github.new
github.git_data.trees.get 'user-name', 'repo-name', 'sha'
github.git_data.trees.get 'user-name', 'repo-name', 'sha' do |file|
  file.path
end

Get a tree recursively

Examples

github = Github.new
github.git_data.trees.get 'user-name', 'repo-name', 'sha', 'recursive' => true
# File lib/github_api/git_data/trees.rb, line 36
def get(*args)
  arguments(args, :required => [:user, :repo, :sha])
  params = arguments.params

  response = if params['recursive']
    params['recursive'] = 1
    get_request("/repos/#{user}/#{repo}/git/trees/#{sha}", params)
  else
    get_request("/repos/#{user}/#{repo}/git/trees/#{sha.to_s}", params)
  end
  return response unless block_given?
  response.tree.each { |el| yield el }
end
Also aliased as: find