Repository

Name	Type	Attributes	Default	Description
`fullname`	`string`			the full name of the repository
`auth`	`Requestable.auth`	<optional>		information required to authenticate to Github
`apiBase`	`string`	<optional>	https://api.github.com	the base Github API URL

_getContentObject(content) → {Object}

Get the object that represents the provided content

Source:

Repository.js, line 267

Parameters:

Name	Type	Description
`content`	`string` \| `Buffer` \| `Blob`	the content to send to the server

Returns:

Type:: Object

the representation of content for the GitHub API

commit(parent, tree, message, optionsopt, cb) → {Promise}

Add a commit to the repository

Source:

Repository.js, line 346

See:

https://developer.github.com/v3/git/commits/#create-a-commit

Parameters:

Name Type Attributes Description

parent

string

the SHA of the parent commit

tree

string

the SHA of the tree for this commit

message

string

the commit message

options

Object

commit options

Name	Type	Attributes	Description
`author`	`Object`	<optional>	the author of the commit
`commiter`	`Object`	<optional>	the committer

cb

Requestable.callback

will receive the commit that is created

Returns:

Type:: Promise

the promise for the http request

compareBranches(base, head, cb) → {Promise}

Compare two branches/commits/repositories

Source:

Repository.js, line 130

See:

https://developer.github.com/v3/repos/commits/#compare-two-commits

Parameters:

Name	Type	Description
`base`	`string`	the base commit
`head`	`string`	the head commit
`cb`	`Requestable.callback`	will receive the comparison

Returns:

Type:: Promise

the promise for the http request

createBlob(content, cb) → {Promise}

Create a blob

Source:

Repository.js, line 255

See:

https://developer.github.com/v3/git/blobs/#create-a-blob

Parameters:

Name	Type	Description
`content`	`string` \| `Buffer` \| `Blob`	the content to add to the repository
`cb`	`Requestable.callback`	will receive the details of the created blob

Returns:

Type:: Promise

the promise for the http request

createBranch(oldBranchopt, newBranch, cb) → {Promise}

Create a new branch from an existing branch.

Source:

Repository.js, line 539

Parameters:

Name	Type	Attributes	Default	Description
`oldBranch`	`string`	<optional>	master	the name of the existing branch
`newBranch`	`string`			the name of the new branch
`cb`	`Requestable.callback`			will receive the commit data for the head of the new branch

Returns:

Type:: Promise

the promise for the http request

createHook(options, cb) → {Promise}

Add a new hook to the repository

Source:

Repository.js, line 607

See:

https://developer.github.com/v3/repos/hooks/#create-a-hook

Parameters:

Name	Type	Description
`options`	`Object`	the configuration describing the new hook
`cb`	`Requestable.callback`	will receive the new webhook

Returns:

Type:: Promise

the promise for the http request

createKey(options, cb) → {Promise}

Add a new deploy key to the repository

Source:

Repository.js, line 662

See:

https://developer.github.com/v3/repos/keys/#add-a-new-deploy-key

Parameters:

Name	Type	Description
`options`	`Object`	the configuration describing the new deploy key
`cb`	`Requestable.callback`	will receive the new deploy key

Returns:

Type:: Promise

the promise for the http request

createProject(options, cb) → {Promise}

Create a new project

Source:

Repository.js, line 879

See:

https://developer.github.com/v3/projects/#create-a-repository-project

Parameters:

Name	Type	Description
`options`	`Object`	the description of the project
`cb`	`Requestable.callback`	will receive the newly created project

Returns:

Type:: Promise

the promise for the http request

createPullRequest(options, cb) → {Promise}

Create a new pull request

Source:

Repository.js, line 563

See:

https://developer.github.com/v3/pulls/#create-a-pull-request

Parameters:

Name	Type	Description
`options`	`Object`	the pull request description
`cb`	`Requestable.callback`	will receive the new pull request

Returns:

Type:: Promise

the promise for the http request

createRef(options, cbopt) → {Promise}

Create a reference

Source:

Repository.js, line 53

See:

https://developer.github.com/v3/git/refs/#create-a-reference

Parameters:

Name	Type	Attributes	Description
`options`	`Object`		the object describing the ref
`cb`	`Requestable.callback`	<optional>	will receive the ref

Returns:

Type:: Promise

the promise for the http request

createRelease(options, cb) → {Promise}

Create a new release

Source:

Repository.js, line 802

See:

https://developer.github.com/v3/repos/releases/#create-a-release

Parameters:

Name	Type	Description
`options`	`Object`	the description of the release
`cb`	`Requestable.callback`	will receive the newly created release

Returns:

Type:: Promise

the promise for the http request

createTree(tree, baseSHA, cb) → {Promise}

Create a new tree in git

Source:

Repository.js, line 327

See:

https://developer.github.com/v3/git/trees/#create-a-tree

Parameters:

Name	Type	Description
`tree`	`Object`	the tree to create
`baseSHA`	`string`	the root sha of the tree
`cb`	`Requestable.callback`	will receive the new tree that is created

Returns:

Type:: Promise

the promise for the http request

deleteFile(branch, path, cb) → {Promise}

Delete a file from a branch

Source:

Repository.js, line 685

See:

https://developer.github.com/v3/repos/contents/#delete-a-file

Parameters:

Name	Type	Description
`branch`	`string`	the branch to delete from, or the default branch if not specified
`path`	`string`	the path of the file to remove
`cb`	`Requestable.callback`	will receive the commit in which the delete occurred

Returns:

Type:: Promise

the promise for the http request

deleteHook(id, cb) → {Promise}

Delete a webhook

Source:

Repository.js, line 630

See:

https://developer.github.com/v3/repos/hooks/#delete-a-hook

Parameters:

Name	Type	Description
`id`	`number`	the id of the webhook to be deleted
`cb`	`Requestable.callback`	will receive true if the call is successful

Returns:

Type:: Promise

the promise for the http request

deleteKey(id, cb) → {Promise}

Delete a deploy key

Source:

Repository.js, line 673

See:

https://developer.github.com/v3/repos/keys/#remove-a-deploy-key

Parameters:

Name	Type	Description
`id`	`number`	the id of the deploy key to be deleted
`cb`	`Requestable.callback`	will receive true if the call is successful

Returns:

Type:: Promise

the promise for the http request

deleteRef(ref, cbopt) → {Promise}

Delete a reference

Source:

Repository.js, line 64

See:

https://developer.github.com/v3/git/refs/#delete-a-reference

Parameters:

Name	Type	Attributes	Description
`ref`	`string`		the name of the ref to delte
`cb`	`Requestable.callback`	<optional>	will receive true if the request is successful

Returns:

Type:: Promise

the promise for the http request

deleteRelease(id, cb) → {Promise}

Delete a release

Source:

Repository.js, line 846

See:

https://developer.github.com/v3/repos/releases/#delete-a-release

Parameters:

Name	Type	Description
`id`	`string`	the release to be deleted
`cb`	`Requestable.callback`	will receive true if the operation is successful

Returns:

Type:: Promise

the promise for the http request

deleteRepo(cbopt) → {Promise}

Delete a repository

Source:

Repository.js, line 74

See:

https://developer.github.com/v3/repos/#delete-a-repository

Parameters:

Name	Type	Attributes	Description
`cb`	`Requestable.callback`	<optional>	will receive true if the request is successful

Returns:

Type:: Promise

the promise for the http request

fork(cb) → {Promise}

Fork a repository

Source:

Repository.js, line 506

See:

https://developer.github.com/v3/repos/forks/#create-a-fork

Parameters:

Name	Type	Description
`cb`	`Requestable.callback`	will receive the information about the newly created fork

Returns:

Type:: Promise

the promise for the http request

forkToOrg(org, cb) → {Promise}

Fork a repository to an organization

Source:

Repository.js, line 518

See:

https://developer.github.com/v3/repos/forks/#create-a-fork

Parameters:

Name	Type	Description
`org`	`String`	organization where you'd like to create the fork.
`cb`	`Requestable.callback`	will receive the information about the newly created fork

Returns:

Type:: Promise

the promise for the http request

getBlob(sha, cb) → {Promise}

Get a raw blob from the repository

Source:

Repository.js, line 151

See:

https://developer.github.com/v3/git/blobs/#get-a-blob

Parameters:

Name	Type	Description
`sha`	`string`	the sha of the blob to fetch
`cb`	`Requestable.callback`	will receive the blob from the API

Returns:

Type:: Promise

the promise for the http request

getBranch(branch, cb) → {Promise}

Get a single branch

Source:

Repository.js, line 162

See:

https://developer.github.com/v3/repos/branches/#get-branch

Parameters:

Name	Type	Description
`branch`	`string`	the name of the branch to fetch
`cb`	`Requestable.callback`	will receive the branch from the API

Returns:

Type:: Promise

the promise for the http request

getCollaborators(cb) → {Promise}

List the users who are collaborators on the repository. The currently authenticated user must have push access to use this method

Source:

Repository.js, line 455

See:

https://developer.github.com/v3/repos/collaborators/#list-collaborators

Parameters:

Name	Type	Description
`cb`	`Requestable.callback`	will receive the list of collaborators

Returns:

Type:: Promise

the promise for the http request

getCommit(sha, cb) → {Promise}

Get a commit from the repository

Source:

Repository.js, line 173

See:

https://developer.github.com/v3/repos/commits/#get-a-single-commit

Parameters:

Name	Type	Description
`sha`	`string`	the sha for the commit to fetch
`cb`	`Requestable.callback`	will receive the commit data

Returns:

Type:: Promise

the promise for the http request

getContents(ref, path, raw, cb) → {Promise}

Get the contents of a repository

Source:

Repository.js, line 479

See:

https://developer.github.com/v3/repos/contents/#get-contents

Parameters:

Name	Type	Description
`ref`	`string`	the ref to check
`path`	`string`	the path containing the content to fetch
`raw`	`boolean`	`true` if the results should be returned raw instead of GitHub's normalized format
`cb`	`Requestable.callback`	will receive the fetched data

Returns:

Type:: Promise

the promise for the http request

getContributors(cb) → {Promise}

List the contributors to the repository

Source:

Repository.js, line 434

See:

https://developer.github.com/v3/repos/#list-contributors

Parameters:

Name	Type	Description
`cb`	`Requestable.callback`	will receive the list of contributors

Returns:

Type:: Promise

the promise for the http request

getContributorStats(cb) → {Promise}

List the contributor stats to the repository

Source:

Repository.js, line 444

See:

https://developer.github.com/v3/repos/#list-contributors

Parameters:

Name	Type	Description
`cb`	`Requestable.callback`	will receive the list of contributors

Returns:

Type:: Promise

the promise for the http request

getDetails(cb) → {Promise}

Get information about the repository

Source:

Repository.js, line 424

See:

https://developer.github.com/v3/repos/#get

Parameters:

Name	Type	Description
`cb`	`Requestable.callback`	will receive the information about the repository

Returns:

Type:: Promise

the promise for the http request

getHook(id, cb) → {Promise}

Get a hook for the repository

Source:

Repository.js, line 596

See:

https://developer.github.com/v3/repos/hooks/#get-single-hook

Parameters:

Name	Type	Description
`id`	`number`	the id of the webook
`cb`	`Requestable.callback`	will receive the details of the webook

Returns:

Type:: Promise

the promise for the http request

getKey(id, cb) → {Promise}

Get a deploy key for the repository

Source:

Repository.js, line 651

See:

https://developer.github.com/v3/repos/keys/#get-a-deploy-key

Parameters:

Name	Type	Description
`id`	`number`	the id of the deploy key
`cb`	`Requestable.callback`	will receive the details of the deploy key

Returns:

Type:: Promise

the promise for the http request

getPullRequest(number, cbopt) → {Promise}

Get information about a specific pull request

Source:

Repository.js, line 107

See:

https://developer.github.com/v3/pulls/#get-a-single-pull-request

Parameters:

Name	Type	Attributes	Description
`number`	`number`		the PR you wish to fetch
`cb`	`Requestable.callback`	<optional>	will receive the PR from the API

Returns:

Type:: Promise

the promise for the http request

getReadme(ref, raw, cb) → {Promise}

Get the README of a repository

Source:

Repository.js, line 494

See:

https://developer.github.com/v3/repos/contents/#get-the-readme

Parameters:

Name	Type	Description
`ref`	`string`	the ref to check
`raw`	`boolean`	`true` if the results should be returned raw instead of GitHub's normalized format
`cb`	`Requestable.callback`	will receive the fetched data

Returns:

Type:: Promise

the promise for the http request

getRef(ref, cbopt) → {Promise}

Get a reference

Source:

Repository.js, line 42

See:

https://developer.github.com/v3/git/refs/#get-a-reference

Parameters:

Name	Type	Attributes	Description
`ref`	`string`		the reference to get
`cb`	`Requestable.callback`	<optional>	will receive the reference's refSpec or a list of refSpecs that match `ref`

Returns:

Type:: Promise

the promise for the http request

getRelease(id, cb) → {Promise}

Get information about a release

Source:

Repository.js, line 835

See:

https://developer.github.com/v3/repos/releases/#get-a-single-release

Parameters:

Name	Type	Description
`id`	`string`	the id of the release
`cb`	`Requestable.callback`	will receive the release information

Returns:

Type:: Promise

the promise for the http request

getSha(branchopt, path, cb) → {Promise}

Get tha sha for a particular object in the repository. This is a convenience function

Source:

Repository.js, line 221

See:

https://developer.github.com/v3/repos/contents/#get-contents

Parameters:

Name	Type	Attributes	Description
`branch`	`string`	<optional>	the branch to look in, or the repository's default branch if omitted
`path`	`string`		the path of the file or directory
`cb`	`Requestable.callback`		will receive a description of the requested object, including a `SHA` property

Returns:

Type:: Promise

the promise for the http request

getSingleCommit(ref, cb) → {Promise}

Gets a single commit information for a repository

Source:

Repository.js, line 208

See:

https://developer.github.com/v3/repos/commits/#get-a-single-commit

Parameters:

Name	Type	Description
`ref`	`string`	the reference for the commit-ish
`cb`	`Requestable.callback`	will receive the commit information

Returns:

Type:: Promise

the promise for the http request

getTree(treeSHA, cb) → {Promise}

Get a description of a git tree

Source:

Repository.js, line 244

See:

https://developer.github.com/v3/git/trees/#get-a-tree

Parameters:

Name	Type	Description
`treeSHA`	`string`	the SHA of the tree to fetch
`cb`	`Requestable.callback`	will receive the callback data

Returns:

Type:: Promise

the promise for the http request

isCollaborator(username, cb) → {Promise}

Check if a user is a collaborator on the repository

Source:

Repository.js, line 466

See:

https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator

Parameters:

Name	Type	Description
`username`	`string`	the user to check
`cb`	`Requestable.callback`	will receive true if the user is a collaborator and false if they are not

Returns:

Type:: Promise

the promise for the http request {Boolean} [description]

isStarred(cb) → {Promise}

Check if a repository is starred by you

Source:

Repository.js, line 771

See:

https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository

Parameters:

Name	Type	Description
`cb`	`Requestable.callback`	will receive true if the repository is starred and false if the repository is not starred

Returns:

Type:: Promise

the promise for the http request {Boolean} [description]

listBranches(cb) → {Promise}

List all the branches for the repository

Source:

Repository.js, line 140

See:

https://developer.github.com/v3/repos/#list-branches

Parameters:

Name	Type	Description
`cb`	`Requestable.callback`	will receive the list of branches

Returns:

Type:: Promise

the promise for the http request

listCommits(optionsopt, cb) → {Promise}

List the commits on a repository, optionally filtering by path, author or time range

Source:

Repository.js, line 189

See:

https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository

Parameters:

Name Type Attributes Description

options

Object

the filtering options for commits

Name	Type	Attributes	Description
`sha`	`string`	<optional>	the SHA or branch to start from
`path`	`string`	<optional>	the path to search on
`author`	`string`	<optional>	the commit author
`since`	`Date` \| `string`	<optional>	only commits after this date will be returned
`until`	`Date` \| `string`	<optional>	only commits before this date will be returned

cb

Requestable.callback

will receive the list of commits found matching the criteria

Returns:

Type:: Promise

the promise for the http request

listForks(cb) → {Promise}

List a repository's forks

Source:

Repository.js, line 528

See:

https://developer.github.com/v3/repos/forks/#list-forks

Parameters:

Name	Type	Description
`cb`	`Requestable.callback`	will receive the list of repositories forked from this one

Returns:

Type:: Promise

the promise for the http request

listHooks(cb) → {Promise}

List the hooks for the repository

Source:

Repository.js, line 585

See:

https://developer.github.com/v3/repos/hooks/#list-hooks

Parameters:

Name	Type	Description
`cb`	`Requestable.callback`	will receive the list of hooks

Returns:

Type:: Promise

the promise for the http request

listKeys(cb) → {Promise}

List the deploy keys for the repository

Source:

Repository.js, line 640

See:

https://developer.github.com/v3/repos/keys/#list-deploy-keys

Parameters:

Name	Type	Description
`cb`	`Requestable.callback`	will receive the list of deploy keys

Returns:

Type:: Promise

the promise for the http request

listProjects(cbopt) → {Promise}

Get information about all projects

Source:

Repository.js, line 868

See:

https://developer.github.com/v3/projects/#list-repository-projects

Parameters:

Name	Type	Attributes	Description
`cb`	`Requestable.callback`	<optional>	will receive the list of projects

Returns:

Type:: Promise

the promise for the http request

listPullRequestFiles(number, cbopt) → {Promise}

List the files of a specific pull request

Source:

Repository.js, line 118

See:

https://developer.github.com/v3/pulls/#list-pull-requests-files

Parameters:

Name	Type	Attributes	Description
`number`	`number` \| `string`		the PR you wish to fetch
`cb`	`Requestable.callback`	<optional>	will receive the list of files from the API

Returns:

Type:: Promise

the promise for the http request

listPullRequests(options, cbopt) → {Promise}

List the open pull requests on the repository

Source:

Repository.js, line 95

See:

https://developer.github.com/v3/pulls/#list-pull-requests

Parameters:

Name	Type	Attributes	Description
`options`	`Object`		options to filter the search
`cb`	`Requestable.callback`	<optional>	will receive the list of PRs

Returns:

Type:: Promise

the promise for the http request

listReleases(cb) → {Promise}

Get information about all releases

Source:

Repository.js, line 824

See:

https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository

Parameters:

Name	Type	Description
`cb`	`Requestable.callback`	will receive the release information

Returns:

Type:: Promise

the promise for the http request

listStatuses(sha, cb) → {Promise}

List the commit statuses for a particular sha, branch, or tag

Source:

Repository.js, line 233

See:

https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref

Parameters:

Name	Type	Description
`sha`	`string`	the sha, branch, or tag to get statuses for
`cb`	`Requestable.callback`	will receive the list of statuses

Returns:

Type:: Promise

the promise for the http request

List the tags on a repository

Source:

Repository.js, line 84

See:

https://developer.github.com/v3/repos/#list-tags

Parameters:

Name	Type	Attributes	Description
`cb`	`Requestable.callback`	<optional>	will receive the tag data

Returns:

Type:: Promise

the promise for the http request

mergePullRequest(number, options, cbopt) → {Promise}

Merge a pull request

Source:

Repository.js, line 858

See:

https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button

Parameters:

Name	Type	Attributes	Description
`number`	`number` \| `string`		the number of the pull request to merge
`options`	`Object`		the merge options for the pull request
`cb`	`Requestable.callback`	<optional>	will receive the merge information if the operation is successful

Returns:

Type:: Promise

the promise for the http request

move(branch, oldPath, newPath, cb) → {Promise}

Change all references in a repo from oldPath to new_path

Source:

Repository.js, line 705

Parameters:

Name	Type	Description
`branch`	`string`	the branch to carry out the reference change, or the default branch if not specified
`oldPath`	`string`	original path
`newPath`	`string`	new reference path
`cb`	`Requestable.callback`	will receive the commit in which the move occurred

Returns:

Type:: Promise

the promise for the http request

star(cb) → {Promise}

Star a repository

Source:

Repository.js, line 781

See:

https://developer.github.com/v3/activity/starring/#star-a-repository

Parameters:

Name	Type	Description
`cb`	`Requestable.callback`	will receive true if the repository is starred

Returns:

Type:: Promise

the promise for the http request

unstar(cb) → {Promise}

Unstar a repository

Source:

Repository.js, line 791

See:

https://developer.github.com/v3/activity/starring/#unstar-a-repository

Parameters:

Name	Type	Description
`cb`	`Requestable.callback`	will receive true if the repository is unstarred

Returns:

Type:: Promise

the promise for the http request

updateHead(ref, commitSHA, force, cb) → {Promise}

Update a ref

Source:

Repository.js, line 376

See:

https://developer.github.com/v3/git/refs/#update-a-reference

Parameters:

Name	Type	Description
`ref`	`string`	the ref to update
`commitSHA`	`string`	the SHA to point the reference to
`force`	`boolean`	indicates whether to force or ensure a fast-forward update
`cb`	`Requestable.callback`	will receive the updated ref back

Returns:

Type:: Promise

the promise for the http request

updateHook(id, options, cb) → {Promise}

Edit an existing webhook

Source:

Repository.js, line 619

See:

https://developer.github.com/v3/repos/hooks/#edit-a-hook

Parameters:

Name	Type	Description
`id`	`number`	the id of the webhook
`options`	`Object`	the new description of the webhook
`cb`	`Requestable.callback`	will receive the updated webhook

Returns:

Type:: Promise

the promise for the http request

updatePullRequest(number, options, cbopt) → {Promise}

Update a pull request

Source:

Repository.js, line 575

See:

https://developer.github.com/v3/pulls/#update-a-pull-request

Parameters:

Name	Type	Attributes	Description
`number`	`number` \| `string`		the number of the pull request to update
`options`	`Object`		the pull request description
`cb`	`Requestable.callback`	<optional>	will receive the pull request information

Returns:

Type:: Promise

the promise for the http request

updateRelease(id, options, cb) → {Promise}

Edit a release

Source:

Repository.js, line 814

See:

https://developer.github.com/v3/repos/releases/#edit-a-release

Parameters:

Name	Type	Description
`id`	`string`	the id of the release
`options`	`Object`	the description of the release
`cb`	`Requestable.callback`	will receive the modified release

Returns:

Type:: Promise

the promise for the http request

updateRepository(options, cb) → {Promise}

Update repository information

Source:

Repository.js, line 414

See:

https://developer.github.com/v3/repos/#edit

Parameters:

Name Type Description

options

object

New parameters that will be set to the repository

Name	Type	Attributes	Description
`name`	`string`		Name of the repository
`description`	`string`	<optional>	A short description of the repository
`homepage`	`string`	<optional>	A URL with more information about the repository
`private`	`boolean`	<optional>	Either true to make the repository private, or false to make it public.
`has_issues`	`boolean`	<optional>	Either true to enable issues for this repository, false to disable them.
`has_wiki`	`boolean`	<optional>	Either true to enable the wiki for this repository, false to disable it.
`has_downloads`	`boolean`	<optional>	Either true to enable downloads, false to disable them.
`default_branch`	`string`	<optional>	Updates the default branch for this repository.

cb

Requestable.callback

will receive the updated repository back

Returns:

Type:: Promise

the promise for the http request

updateStatus(commitSHA, options, cb) → {Promise}

Update commit status

Source:

Repository.js, line 395

See:

https://developer.github.com/v3/repos/statuses/

Parameters:

Name Type Description

commitSHA

string

the SHA of the commit that should be updated

options

object

Commit status parameters

Name	Type	Attributes	Description
`state`	`string`		The state of the status. Can be one of: pending, success, error, or failure.
`target_url`	`string`	<optional>	The target URL to associate with this status.
`description`	`string`	<optional>	A short description of the status.
`context`	`string`	<optional>	A string label to differentiate this status among CI systems.

cb

Requestable.callback

will receive the updated commit back

Returns:

Type:: Promise

the promise for the http request

updateTree(baseTreeSHA, path, blobSHA, cb) → {Promise}

Update a tree in Git

Deprecated:

use Repository#createTree instead

Source:

Repository.js, line 305

See:

https://developer.github.com/v3/git/trees/#create-a-tree

Parameters:

Name	Type	Description
`baseTreeSHA`	`string`	the SHA of the tree to update
`path`	`string`	the path for the new file
`blobSHA`	`string`	the SHA for the blob to put at `path`
`cb`	`Requestable.callback`	will receive the new tree that is created

Returns:

Type:: Promise

the promise for the http request

writeFile(branch, path, content, message, optionsopt, cb) → {Promise}

Write a file to the repository

Source:

Repository.js, line 740

See:

https://developer.github.com/v3/repos/contents/#update-a-file

Parameters:

Name Type Attributes Description

branch

string

the name of the branch

path

string

the path for the file

content

string

the contents of the file

message

string

the commit message

options

Object

commit options

Name	Type	Attributes	Description
`author`	`Object`	<optional>	the author of the commit
`commiter`	`Object`	<optional>	the committer
`encode`	`boolean`	<optional>	true if the content should be base64 encoded

cb

Requestable.callback

will receive the new commit

Returns:

Type:: Promise

the promise for the http request

Constructor

new Repository(fullname, authopt, apiBaseopt)

Parameters:

Methods

_getContentObject(content) → {Object}

Parameters:

Returns:

commit(parent, tree, message, optionsopt, cb) → {Promise}

Parameters:

Returns:

compareBranches(base, head, cb) → {Promise}

Parameters:

Returns:

createBlob(content, cb) → {Promise}

Parameters:

Returns:

createBranch(oldBranchopt, newBranch, cb) → {Promise}

Parameters:

Returns:

createHook(options, cb) → {Promise}

Parameters:

Returns:

createKey(options, cb) → {Promise}

Parameters:

Returns:

createProject(options, cb) → {Promise}

Parameters:

Returns:

createPullRequest(options, cb) → {Promise}

Parameters:

Returns:

createRef(options, cbopt) → {Promise}

Parameters:

Returns:

createRelease(options, cb) → {Promise}

Parameters:

Returns:

createTree(tree, baseSHA, cb) → {Promise}

Parameters:

Returns:

deleteFile(branch, path, cb) → {Promise}

Parameters:

Returns:

deleteHook(id, cb) → {Promise}

Parameters:

Returns:

deleteKey(id, cb) → {Promise}

Parameters:

Returns:

deleteRef(ref, cbopt) → {Promise}

Parameters:

Returns:

deleteRelease(id, cb) → {Promise}

Parameters:

Returns:

deleteRepo(cbopt) → {Promise}

Parameters:

Returns:

fork(cb) → {Promise}

Parameters:

Returns:

forkToOrg(org, cb) → {Promise}

Parameters:

Returns:

getBlob(sha, cb) → {Promise}

Parameters:

Returns:

getBranch(branch, cb) → {Promise}

Parameters:

Returns:

getCollaborators(cb) → {Promise}

Parameters:

Returns:

getCommit(sha, cb) → {Promise}

Parameters:

Returns:

getContents(ref, path, raw, cb) → {Promise}

Parameters:

Returns: