ssb-pull-requests
Pull requests for ssb-git-repos, inheriting from ssb-issues.
API
var Pulls = require('ssb-pull-requests')
var pulls = Pulls.init(sbot)
get: async
Get a pull request by its id
pulls
→
id: Ref created_at: timestamp headRepo: Ref headBranch: string baseRepo: Ref baseBranch: string title: string? text: string? open: boolean mergeable: boolean?}
mergeable
: whether the pull request can be automatically merged (true
), or not (false
), or it is unknown (null
)
getRevs: async
Get the base and head revisions for a pull request. These revs may be used to calculate what changes are in a pull request when the revs of the branches may have changed if the pull request was merged or the upstream diverged.
pulls
→
head: string base: string
base
: commit ID of the branch to request changes pulled intohead
: commit ID of the branch to pull from
list: source
Get a stream of pull requests
issues
repo
(Ref): filter by base git-ssb repoheadRepo
(Ref): filter by head git-ssb repoopen
(boolean): filter by open/closed statusauthor
(FeedRef): get only pull requests created by the given feedlive
(boolean, default:false
): Keep the stream open and emit new messages as they are received.gt
(greater than),gte
(greater than or equal): maximum[timestamp, id]
lt
(less than),lte
(less than or equal): minimum[timestamp, id]
reverse
(boolean, default:false
): reverse the order of results
→
id: Ref created_at: timestamp repo: Ref branch: string head_repo: Ref head_branch: string title: string? text: string? open: boolean mergeable: boolean?}
mergeable
: whether the pull request can be automatically merged
deinit: async
Deinit pulls
. Closes all live streams.
pulls
Schemas
var prSchemas = Pullsschemas
prSchemas.new(baseRepo, baseBranch, headRepo, headBranch[, title], text)
Create a pull request. A pull request is a request to pull from a branch of one git-ssb repo (head), to a branch on another git-ssb repo (base).
baseRepo
(Ref): repo to request changes pulled intobaseBranch
(string): branch of the repo to request changes pulled intoheadRepo
(Ref): repo where the changes are implementedheadBranch
(string): branch of the repo to pull fromtitle
(string): title of the pull request (deprecated)text
(string): text describing the pull request
→
type: 'pull-request' project: Ref repo: Ref branch: string base_repo: Ref base_branch: string title: string? text: string?}
License
Copyright (c) 2016 Charles Lehner
Usage of the works is permitted provided that this instrument is retained with the works, so that any entity that uses the works is notified of this instrument.
DISCLAIMER: THE WORKS ARE WITHOUT WARRANTY.