https://github.com/assemble/assemblebot
Bot for responding to github issues opened on assemble repositories.
https://github.com/assemble/assemblebot
Last synced: about 1 year ago
JSON representation
Bot for responding to github issues opened on assemble repositories.
- Host: GitHub
- URL: https://github.com/assemble/assemblebot
- Owner: assemble
- License: mit
- Created: 2015-12-17T19:57:11.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-01-04T15:04:17.000Z (over 9 years ago)
- Last Synced: 2025-03-23T00:01:45.791Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 60.5 KB
- Stars: 5
- Watchers: 5
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# assemblebot [](https://www.npmjs.com/package/assemblebot) [](https://travis-ci.org/assemble/assemblebot)
> Bot for responding to github issues opened on assemble repositories.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install assemblebot --save
```
## Usage
```js
var AssembleBot = require('assemblebot');
```
## API
### [AssembleBot](index.js#L27)
Main class for creating a new AssembleBot instance. This bot extends [GithubBot](https://github.com/doowb/githubbot) and creates an instance of [assemble-core](https://github.com/assemble/assemble-core) that can be used to render response templates.
**Params**
* `options` **{Object}**: Options to use to configure the bot.
* `options.GITHUB_TOKEN` **{String}**: Personal github token the bot uses to post to github issues.
**Example**
```js
var bot = new AssembleBot({GITHUB_TOKEN: 'xxxxxxxxxxxxxxx'});
```
## Handlers
This bot implements the following github webhook event handlers:
## Related projects
* [assemble](https://www.npmjs.com/package/assemble): Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… [more](https://www.npmjs.com/package/assemble) | [homepage](https://github.com/assemble/assemble)
* [base-bot](https://www.npmjs.com/package/base-bot): Simple bot that knows how to handle events when told too. Use base bot to… [more](https://www.npmjs.com/package/base-bot) | [homepage](https://github.com/doowb/base-bot)
* [githubbot](https://www.npmjs.com/package/githubbot): Starting point for registering event handlers and handling payloads coming from github webhooks. Allows usage… [more](https://www.npmjs.com/package/githubbot) | [homepage](https://github.com/doowb/githubbot)
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/doowb/assemblebot/issues/new).
## Building docs
Generate readme and API documentation with [verb][]:
```sh
$ npm install verb && npm run docs
```
Or, if [verb][] is installed globally:
```sh
$ verb
```
## Running tests
Install dev dependencies:
```sh
$ npm install -d && npm test
```
## Author
**Brian Woodward**
* [github/doowb](https://github.com/doowb)
* [twitter/doowb](http://twitter.com/doowb)
## License
Copyright © 2016 [Brian Woodward](https://github.com/doowb)
Released under the [MIT license](https://github.com/assemble/assemblebot/blob/master/LICENSE).
***
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on March 16, 2016._