hubot/README.md: Mention HUBOT_LOG_LEVEL
authorW. Trevor King <wking@tremily.us>
Mon, 3 Mar 2014 16:46:09 +0000 (08:46 -0800)
committerW. Trevor King <wking@tremily.us>
Mon, 3 Mar 2014 16:46:09 +0000 (08:46 -0800)
Strangely, this environment variable does not seem to be documented at
all:

  hubot$ git grep HUBOT_LOG_LEVEL
  src/robot.coffee:    @logger    = new Log process.env.HUBOT_LOG_LEVEL or 'info'

hubot/README.md

index 131a3ddd0857a3180a14cc1f0055c9de7e24c179..e38a75b459d9f3d580bf9238d04d660df87f28b9 100644 (file)
@@ -34,6 +34,9 @@ If you want the GitHub scripts to be able to access private
 repositories (e.g. to link to private issues or commits), you need to
 set `HUBOT_GITHUB_TOKEN` to your [OAuth token][token].
 
+If things aren't working as you'd expect, you can crank up the logging
+with `HUBOT_LOG_LEVEL=debug` (see [robot.coffee][]).
+
 [hubot]: https://github.com/github/hubot
 [hubot-irc]: https://github.com/nandub/hubot-irc
 [scripts]: https://github.com/github/hubot-scripts/tree/master/src/scripts
@@ -47,3 +50,4 @@ set `HUBOT_GITHUB_TOKEN` to your [OAuth token][token].
 [redis-brain]: https://github.com/github/hubot-scripts/blob/master/src/scripts/redis-brain.coffee
 [redis]: ../redis/
 [token]: https://help.github.com/articles/creating-an-access-token-for-command-line-use
+[robot.coffee]: https://github.com/github/hubot/blob/master/src/robot.coffee