{"id":19601481,"url":"https://github.com/stackstorm/hubot-stackstorm","last_synced_at":"2025-04-05T04:14:51.749Z","repository":{"id":33089118,"uuid":"36726556","full_name":"StackStorm/hubot-stackstorm","owner":"StackStorm","description":"Hubot plugin for integration with StackStorm event-driven infrastructure automation platform.","archived":false,"fork":false,"pushed_at":"2024-01-13T09:30:59.000Z","size":1044,"stargazers_count":49,"open_issues_count":31,"forks_count":37,"subscribers_count":32,"default_branch":"master","last_synced_at":"2024-03-15T06:23:34.981Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/StackStorm.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.rst","contributing":null,"funding":"FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"community_bridge":"stackstorm"}},"created_at":"2015-06-02T10:45:53.000Z","updated_at":"2024-06-19T09:59:30.046Z","dependencies_parsed_at":"2024-01-13T11:45:17.766Z","dependency_job_id":null,"html_url":"https://github.com/StackStorm/hubot-stackstorm","commit_stats":{"total_commits":447,"total_committers":36,"mean_commits":"12.416666666666666","dds":0.7472035794183445,"last_synced_commit":"e565c50d0cda08b2d7952ebbf29e521c9b216615"},"previous_names":[],"tags_count":47,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StackStorm%2Fhubot-stackstorm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StackStorm%2Fhubot-stackstorm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StackStorm%2Fhubot-stackstorm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StackStorm%2Fhubot-stackstorm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StackStorm","download_url":"https://codeload.github.com/StackStorm/hubot-stackstorm/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247284954,"owners_count":20913704,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T09:18:35.477Z","updated_at":"2025-04-05T04:14:51.721Z","avatar_url":"https://github.com/StackStorm.png","language":"JavaScript","readme":"[![StackStorm](https://github.com/stackstorm/st2/raw/master/stackstorm_logo.png)](http://www.stackstorm.com)\n\n[![Build Status](https://api.travis-ci.org/StackStorm/hubot-stackstorm.svg?branch=master)](https://travis-ci.org/StackStorm/hubot-stackstorm) [![IRC](https://img.shields.io/irc/%23stackstorm.png)](http://webchat.freenode.net/?channels=stackstorm)\n\n# StackStorm Hubot Plugin\n\nHubot plugin for integrating with StackStorm event-driven infrastructure\nautomation platform.\n\n## Installing and configuring the plugin\n\nTo install and configure the plugin, first install hubot by following the\ninstallation instructions at https://hubot.github.com/docs/.\n\nAfter you have installed hubot and generated your bot, go to your bot directory\nand install the plugin npm package:\n\n```bash\nnpm install hubot-stackstorm\n```\n\nAfter that, edit the `external-scripts.json` file in your bot directory and\nmake sure it contains ``hubot-stackstorm`` entry.\n\n```json\n[\n  ...\n  \"hubot-stackstorm\"\n]\n```\n\nFinal file should look something like that:\n\n```json\n\n[\n  \"hubot-diagnostics\",\n  \"hubot-help\",\n  \"hubot-heroku-keepalive\",\n  \"hubot-google-images\",\n  \"hubot-google-translate\",\n  \"hubot-pugme\",\n  \"hubot-maps\",\n  \"hubot-redis-brain\",\n  \"hubot-rules\",\n  \"hubot-shipit\",\n  \"hubot-youtube\",\n  \"hubot-stackstorm\"\n]\n```\n\nIf you want to use this plugin with a Slack adapter, you also need to install\n`hubot-slack` npm package.\n\n```bash\nnpm install hubot-slack\n```\n\nAfter that's done, you are ready to start your bot.\n\n## Plugin environment variable options\n\nTo configure the plugin behavior, the following environment variable can be\nspecified when running hubot:\n\n* `ST2_API_URL` - URL to the StackStorm API endpoint.\n* `ST2_WEBUI_URL` - Base URL to the WebUI. If provided, link to the execution\n  history will be provided in the chat after every execution (optional).\n* `ST2_AUTH_USERNAME` - API credentials - username (optional).\n* `ST2_AUTH_PASSWORD` - API credentials - password (optional).\n* `ST2_AUTH_URL` - URL to the StackStorm Auth API (optional).\n* `ST2_STREAM_URL` - URL to the StackStorm Stream API (optional).\n* `ST2_COMMANDS_RELOAD_INTERVAL` - How often the list of available commands\n  should be reloaded. Defaults to every 120 seconds (optional).\n* `ST2_MAX_MESSAGE_LENGTH` - Message truncation to preserve chat context. Default is 500 characters of length. 0 means no limit (optional).\n* `ST2_SLACK_SUCCESS_COLOR` - Slack attachement color for success, can either be one of good, warning, danger, or any hex color code (optional).\n* `ST2_SLACK_FAIL_COLOR` - Slack attachement color for failures either be one of good, warning, danger, or any hex color code (optional).\n* `ST2_ROCKETCHAT_SUCCESS_COLOR` - RocketChat attachement color for success, can either be one of good, warning, danger, or any hex color code (optional).\n* `ST2_ROCKETCHAT_FAIL_COLOR` - RocketChat attachement color for failures either be one of good, warning, danger, or any hex color code (optional).\n\nNote: ``ST2_ROUTE`` environment variable mentioned below should only be\nspecified if you modified the rule which comes with a ``hubot`` pack to use a\nnon default value of ``hubot`` for the ``trigger.route`` criteria.\n\n* `ST2_ROUTE` - StackStorm notification channel where all the notification messages\n  should be sent to. This is the reference to the channel construct internal\n  to StackStorm's notification system. Make sure this value is set to whatever\n  is assigned the rule that defines a StackStrom channel. e.g. `hubot` is a value\n  that works well with the `hubot` pack found at\n  https://github.com/StackStorm/st2contrib/tree/master/packs/hubot.\n\n## Running the bot\n\nTo run the bot, go to your bot directory and run the following command:\n\n```bash\nST2_AUTH_USERNAME=testu ST2_AUTH_PASSWORD=testp HUBOT_SLACK_TOKEN=token ST2_ROUTE=mychannel PORT=8181 bin/hubot --name \"st2-bot\" -a slack --alias !\n```\n\n\nKeep in mind that you need to replace values of the environment variables so they\nreflect configuration of your environment.\n\n## Known issues / limitations\n\nPlease see https://github.com/StackStorm/hubot-stackstorm/issues\n\n## Testing\n\n### Lint\n\n```bash\ngulp lint\n```\n\n### Tests\n\n```bash\ngulp test\n```\n\n## Publishing\n\nReminder to ourselves, instead of bumping the version manually, use `mversion`.\n\n```\nnpm install -g mversion\nmversion patch\n```\n\nThis will bump the version in `package.json`, commit and create a tag with format described in `.mversionrc`.\n\n## Copyright, License, and Contributors Agreement\n\nCopyright 2015-2019 Extreme Networks, Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the [LICENSE](LICENSE) file, or at:\n\n[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n\nBy contributing you agree that these contributions are your own (or approved by your employer) and you grant a full, complete, irrevocable copyright license to all users and developers of the project, present and future, pursuant to the license of the project.\n","funding_links":["https://funding.communitybridge.org/projects/stackstorm"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackstorm%2Fhubot-stackstorm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstackstorm%2Fhubot-stackstorm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackstorm%2Fhubot-stackstorm/lists"}