hubot-traq v2.0.0

hubot-traq

traQ用Hubotアダプター

使い方

新しいbotをつくる

インストール

前提としてNode.jsが必要です

# 利用ツールのインストール
npm install -g yo generator-hubot
# botを管理するディレクトリの作成
mkdir -p /path/to/myhubot
cd /path/to/myhubot
# テンプレートの作成
yo hubot

ここまでしたら、画面にしたがって入力していき、Bot adapterと表示されたらhubot-traqと入力します
(もしくはyo hubotのあとにすべてコマンド引数で指定することもできます)

既定で入っているscriptsが存在するので一度除きます(このままだとredisがないだの怒られるため)
具体的には./external-scripts.jsonを開いて[]にします
追加でpackage.jsonのdependenciesのhubotとhubot-traq以外を取り除いてnpm installをするといいでしょう

# gitレポジトリの作成
git init
git add .
git commit -m "Init"

初期設定

下記の環境変数をそれぞれ設定します

• HUBOT_TRAQ_NAME - traQで動かすHubotのtraQ ID (例: @BOT_TESTならBOT_TEST)
• HUBOT_TRAQ_MODE - BOTのモード (HTTPまたはWebSocket、省略時はHTTP)
• HUBOT_TRAQ_ACCESS_TOKEN - traQで動かすHubotのAccess Token
• HUBOT_TRAQ_EMBED - メンション・チャンネルリンクの自動埋め込みの有無(TRUEにすると有効、省略時は無効)
• PORTまたはEXPRESS_PORT - HTTPモードでのポート (省略時は8080)
• 以下はHTTPモードのときのみ必要
  • HUBOT_TRAQ_VERIFY_TOKEN - traQで動かすHubotのVerification Code
  • HUBOT_TRAQ_PATH - Botサーバーエンドポイントのパス(直下で受け取るなら""、/webhook/で受け取るなら"/webhook/")

Verification CodeなどはそれぞれtraQのBot Consoleから確認できます

実行

package.jsonのscriptsのstartを以下のように変更します

-    "start": "hubot -a hubot-traq",
+    "start": "hubot -a hubot-traq -n \"$HUBOT_TRAQ_NAME\" \"$@\"",

showcaseへのデプロイ

以下の設定で動作します

• Deploy Type: Runtime
• Build Type: Buildpack
  • Context: .
  • Use Database: BotでDBを使うか次第

さらに詳しい説明はhubotのドキュメントを参照してください

Changelog

• Change log

リファレンス

• Wiki
• Example
• Example with Typescript