git ssb


0+

cel / %V53yIAO6ZNGv1Lx9tCP…



forked from cel / ssb-issues

Branch:

Stephen Whitmore committed Use first line of issue text as its title.Latest: 5ea6e56 on 11/9/2016, 3:51:09 PM
📄README.md
📄index.js
📁lib
📄package.json
📄test.js

ssb-issues

Issue tracking built on secure-scuttlebutt

Schema

type: issue

An issue. Represents something that should be fixed.

{
  type: 'issue',
  project: Link?,
  title: string?,
  text: string?
}

issue edits

Edits to an issue may be done by any ssb message type. For example, you can make a post that updates an issue, or push a git commit that updates an issue. If the message does not have any content other than to update the issue, then the type may be issue-edit.

{
  type: 'issue-edit'|'post'|'git-update',
  issues: [{
    link: IssueRef,
    open: boolean,
  }]
}

API

var Issues = require('ssb-issues')
var issues = Issues.init(sbot)

get: async

Get an issue by its id

issues.get(issueId, cb)

The resulting issue object is as follows:

{
  id: MsgRef,
  author: FeedRef,
  project: Ref?,
  projectAuthor: FeedRef?,
  created_at: number, 
  updated_at: number,
  open: boolean,
  msg: Msg,
}

list: source

Get a stream of issues

issues.list({ project:, open:, author:, live:, gt:, gte:, lt:, lte:, reverse: })

new: async

Create a new issue

issues.new({ project:, title:, text: }, cb)

close: async

issues.close(id, cb)

Mark an issue as closed.

id (MsgRef): id of the issue to reopen

reopen: async

issues.reopen(id, cb)`

Mark an issue as open.

id (MsgRef): id of the issue to reopen text (string): text to accompany the open action

edit: async

issues.edit(id, opts, cb)`

Edit an issue.

id (MsgRef): id of the issue to reopen opts.open (boolean): set open/closed status opts.title (string): set title (deprecated)

isStatusChanged: sync

var open = issueSchemas.isStatusChanged(issue, msg)

Check if a message changes an issue's status

getMention: sync

var mention = issueSchemas.getMention(issue, msg)

Get a mention of an issue in a message, if any

deinit: async

Deinit the issues object. Closes all live streams. Since issues uses live streams, you should call deinit when you are done with the issues and want your program to exit or free up resources.

pulls.deinit(cb)

schemas

var issueSchemas = Issues.schemas

issueSchemas.new(project, title, text)

Create a new issue.

issueSchemas.edit(id, opts)

Edit an issue.

issueSchemas.close(id)

Close an issue.

issueSchemas.reopen(id)

Reopen an issue.

issueSchemas.closes(msg, id)

Mutate a message to make it close an issue

issueSchemas.reopens(msg, id)

Mutate a message to make it reopen an issue

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.


Built with git-ssb-web