Pull-request NPM

pull-request

All the tools you need to commit to GitHub repos via the API and create pull requests

Supports:

exists: check if a repository already exists so you don't try and fork again
fork: fork a repository so you get a copy to edit
branch: create a new branch in a repository to edit
commit: commit changes to files within a branch
pull: create a pull request to have a human merge those changes

Installation

npm install pull-request

API

pr.exists(user, repo, options, callback)

Returns true if github.com/:user/:repo exists, and false if requesting that url returns an error.

pr.fork(user, repo, options, callback)

Forks the repo github.com/:user/:repo to the authenticated user and waits until the fork operation completes. To fork to an organization, just add an organization string to the options object.

N.B. forking will currently appear successful even if the target repo already exists. This functionality should not be relied upon and is subject to change without necessarily updating the MAJOR version.

options:

See github-basic and note that auth is required

pr.branch(user, repo, from, to, options, callback)

Creates a new branch in github.com/:user/:repo using from as the source branch and to as the new branch name.

pr.commit(user, repo, commit, options, callback)

Commits a set of changes to github.com/:user/:repo. It only supports updating text files.

commit:

An object with:

property	type	default	description
branch	`String`	`'master'`	The branch to commit to
message	`String`	required	The commit message
updates	`Array<FileUpdate>`	required	The actual changes to make

FileUpdate:

An object with:

property	type	default	description
path	`String`	required	The file path within the repo (e.g. `test/index.js`)
content	`String`	required	The new content of the file
mode	`String`	`'100644'`	The mode to commit the file with (you probably don't want to change this)
type	`String`	`'blob'`	The type of entry to create (you probably don't want to change this)