freaktechnik/irc-issues-bot
Archived
1
0
Fork 0
Code Issues 3 Pull requests 5 Packages Projects Releases Wiki Activity
A node based irc bot that links to issues when they are mentioned. Currently running on irc.mozilla.org
This repository has been archived on 2022-08-26. You can view files and clone it, but cannot push or open issues or pull requests.
238 commits 13 branches 0 tags 854 KiB
JavaScript 99.9%
Go to file
greenkeeper[bot] 7a244b1cfe Update nyc to the latest version 🚀 (#122) 
* chore(package): update nyc to version 15.0.0

* chore(package): update lockfile package-lock.json
2019-12-23 23:28:37 +01:00
test chore: update deps 2019-10-13 03:04:19 +02:00
.editorconfig tests: add editorconfig 2018-11-10 16:16:26 +01:00
.eslintrc.json chore: Replace eslint-plugin-freaktechnik with dedicated configs. Fixes #68 2017-10-16 01:53:50 +02:00
.gitignore Add tests 2017-02-01 00:03:34 +01:00
.travis.yml Add tests 2017-02-01 00:03:34 +01:00
eventbot.js Fix lint 2017-09-29 00:20:13 +02:00
issuesbot.js chore: move to new field name for issue number 2019-04-18 20:29:03 +02:00
LICENSE tests: add editorconfig 2018-11-10 16:16:26 +01:00
main.js chore: update deps 2019-10-13 03:04:19 +02:00
package-lock.json Update nyc to the latest version 🚀 (#122) 2019-12-23 23:28:37 +01:00
package.json Update nyc to the latest version 🚀 (#122) 2019-12-23 23:28:37 +01:00
Procfile Use env vars for config, too 2015-12-26 21:01:52 +01:00
quipsbot.js refactor: use promises 2018-11-10 16:08:58 +01:00
README.md tests: add editorconfig 2018-11-10 16:16:26 +01:00
scheduler.js Fix lint 2017-09-29 00:20:13 +02:00
storage.js fix: try to fix redis init 2018-11-20 20:12:11 +01:00

README.md

irc-issues-bot

Build Status Greenkeeper badge Dependency Status codecov

A node based IRC bot that links to issues when they are mentioned. It describes itself when PMd.

Installation

Just run npm i in the root directory of the repository.

Bot Usage

Start the bot using node main.js server username [ownername] [password]. You don't have to set owenername, but without it, you'll have a hard time controlling the bot. The arguments can alternatively be specified in these env vars:

  • IRCBOT_SERVER: IRC server address
  • IRCBOT_USERNAME: Username of the bot
  • IRCBOT_OWNER: User with unquestioned control over the bot
  • IRCBOT_PASSWORD: NickServ password
  • IRCBOT_PORT: To connect to an alternate port other than 6697
  • IRCBOT_NOTSECURE: Don't connect via secure connection

Set the REDIS_URL environment variable to use redis instead of plain text files for config storage.

You can /invite the bot to channels.

The owner and channel mods can adjust the channel settings. Check !help in a private message to the bot for more info.

Issue Number Patterns

The bot recognizes the following issues patterns (if the issues bot is activated for a channel):

IssuesBot

issuesbot.js exports the IssuesBot object, which requires an irc.Client plus a repo spec in the form of "owner/repo" as arguments.