ssb-pull-requests1.0.0 • Public • Published
var Pulls = require('ssb-pull-requests') var pulls = Pulls.init(sbot)
Get a pull request by its id
id: Refcreated_at: timestampheadRepo: RefheadBranch: stringbaseRepo: RefbaseBranch: stringtitle: string?text: string?open: booleanmergeable: boolean?}
mergeable: whether the pull request can be automatically merged (
true), or not (
false), or it is unknown (
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.
head: stringbase: string
base: commit ID of the branch to request changes pulled into
head: commit ID of the branch to pull from
Get a stream of pull requests
repo(Ref): filter by base git-ssb repo
headRepo(Ref): filter by head git-ssb repo
open(boolean): filter by open/closed status
author(FeedRef): get only pull requests created by the given feed
false): Keep the stream open and emit new messages as they are received.
gte(greater than or equal): maximum
lte(less than or equal): minimum
false): reverse the order of results
id: Refcreated_at: timestamprepo: Refbranch: stringhead_repo: Refhead_branch: stringtitle: string?text: string?open: booleanmergeable: boolean?}
mergeable: whether the pull request can be automatically merged
pulls. Closes all live streams.
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 into
baseBranch(string): branch of the repo to request changes pulled into
headRepo(Ref): repo where the changes are implemented
headBranch(string): branch of the repo to pull from
title(string): title of the pull request (deprecated)
text(string): text describing the pull request
type: 'pull-request'project: Refrepo: Refbranch: stringbase_repo: Refbase_branch: stringtitle: string?text: string?}
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.