hubot-scriptsThese are a collection of community scripts for hubothubot, a chat bot for your company.
Important: this repository is no longer accepting new scripts. Please read CONTRIBUTING.md for details.
There is a new system for distributing scripts, and adding them to your own hubot. Locate the appropriate script in the hubot-scripts organization or on npm tagged as hubot-scripts, and follow the script's documentation. In general, this will be something like:
- Add a line to external-scripts.json
- Add a line to package.json
- Add environment variables, depending on the script
DiscoveringCheck out the hubot-script-catalogscript-catalog for a list and description of all the available scripts.
InstallingOnce you have Hubot installed, you should already have
package.jsonto be sure. If that is the case, you update
hubot-scripts.jsonto list any scripts from this repository you want to load. The default
If you update
package.json, you will automatically get updates to your scripts listed here.
Alternatively, you can copy files from this repository into your
scriptsdirectory. Note that you would not get updates from the
hubot-scriptsrepository unless you copy them yourself.
Any third-party dependencies for scripts need the addition of your
package.jsonotherwise a lot of errors will be thrown during the start up of your hubot. You can find a list of dependencies for a script in the documentation header at the top of the script.
Restart your robot, and you're good to go.
All the scripts in this repository are located in
Additionally, it's extremely helpful to add TomDoctomdoc to the top of each file. (Check out an exampleexample-script-doc). We'll pull out the commands from those lines and display them in the generic, robot-wide
Please note we're no longer including external dependencies in the
package.json, so should you wish to include them please include the package name and required version in the TomDoc comments at the top of your script.
DocumentationWe're now requiring all scripts in hubot-scripts to contain a documentation header so people know everything about the script.
# Description # <description of the scripts functionality> # # Dependencies: # "<module name>": "<module version>" # # Configuration: # LIST_OF_ENV_VARS_TO_SET # # Commands: # hubot <trigger> - <what the respond trigger does> # <trigger> - <what the hear trigger does> # # Notes: # <optional notes required for the script> # # Author: # <github username of the original script author>
If you have nothing to fill in for a section you should include
Nonein that section. Empty sections which are optional should be left blank. A script will be required to fill out the documentation before being merged into the repository.