Featured scripts docs

featired_scripts_docs.json

{
  "misc": [
    {
      "name": "redis-brain",
      "description": [],
      "dependencies": [
        {
          "name": "redis",
          "version": "~0.10.1"
        }
      ],
      "configuration": {
        "description": [
          "REDIS_URL (optional)"
        ],
        "envs": [
          {
            "pattern": "REDIS_URL"
          }
        ]
      },
      "commands": [],
      "author": [
        "atmos, jan0sch"
      ]
    }
  ],
  "github": [
    {
      "name": "github-activity",
      "description": [],
      "dependencies": [
        {
          "name": "date-utils",
          "version": ">=1.2.5"
        },
        {
          "name": "githubot",
          "version": "0.4.x"
        }
      ],
      "configuration": {
        "description": [
          "HUBOT_GITHUB_TOKEN",
          "HUBOT_GITHUB_USER",
          "HUBOT_GITHUB_API (optional)"
        ],
        "envs": [
          {
            "pattern": "HUBOT_GITHUB_TOKEN",
            "required": true
          },
          {
            "pattern": "HUBOT_GITHUB_USER",
            "required": true
          },
          {
            "pattern": "HUBOT_GITHUB_API"
          }
        ]
      },
      "commands": [
        "hubot repo show <repo> - shows activity of repository"
      ],
      "notes": [
        "HUBOT_GITHUB_API allows you to set a custom URL path (for Github enterprise users)"
      ],
      "author": [
        "vquaiato"
      ]
    },
    {
      "name": "github-commit-link",
      "description": [
        "Github commit link looks for <SHA> and links to that commit for your default",
        "repo. Eg. \"Hey guys check out commit 251a8fb\""
      ],
      "dependencies": [
        {
          "name": "githubot",
          "version": "0.4.x"
        }
      ],
      "configuration": {
        "description": [
          "HUBOT_GITHUB_REPO",
          "The `user/repository` that you want to connect to. example: github/hubot-scripts",
          "HUBOT_GITHUB_TOKEN",
          "You can retrieve your github token via:",
          "curl -i https://api.github.com/authorizations -d '{\"scopes\":[\"repo\"]}' -u \"yourusername\"",
          "Enter your Github password when prompted. When you get a response, look for the \"token\" value",
          "See the following for more details:",
          "http://developer.github.com/v3/oauth/#create-a-new-authorization",
          "https://github.com/iangreenleaf/githubot",
          "HUBOT_GITHUB_API (optional)",
          "Default is https://api.github.com. Override with",
          "http[s]://yourdomain.com/api/v3/ for Enterprise installations."
        ],
        "envs": [
          {
            "pattern": "HUBOT_GITHUB_REPO",
            "required": true
          },
          {
            "pattern": "HUBOT_GITHUB_TOKEN",
            "required": true
          },
          {
            "pattern": "HUBOT_GITHUB_API"
          }
        ]
      },
      "commands": [
        "Listens for <SHA> and links to the commit for your default repo on github"
      ],
      "author": [
        "achiu"
      ]
    },
    {
      "name": "github-commiters",
      "description": [
        "Show the commiters from a repo"
      ],
      "dependencies": [
        {
          "name": "githubot",
          "version": "0.4.x"
        }
      ],
      "configuration": {
        "description": [
          "HUBOT_GITHUB_TOKEN",
          "HUBOT_GITHUB_API (optional)"
        ],
        "envs": [
          {
            "pattern": "HUBOT_GITHUB_TOKEN",
            "required": true
          },
          {
            "pattern": "HUBOT_GITHUB_API"
          }
        ]
      },
      "commands": [
        "hubot repo commiters <repo> - shows commiters of repository",
        "hubot repo top-commiters <repo> - shows top commiters of repository"
      ],
      "notes": [
        "HUBOT_GITHUB_API allows you to set a custom URL path (for Github enterprise users)"
      ],
      "author": [
        "vquaiato"
      ]
    },
    {
      "name": "github-credentials",
      "description": [
        "Github Credentials allows you to map your user against your GitHub user.",
        "This is specifically in order to work with apps that have GitHub Oauth users."
      ],
      "dependencies": [],
      "configuration": {
        "description": [],
        "envs": []
      },
      "commands": [
        "hubot who do you know - List all the users with github logins tracked by Hubot",
        "hubot i am `maddox` - map your user to the github login `maddox`",
        "hubot who am i - reveal your mapped github login",
        "hubot forget me - de-map your user to your github login"
      ],
      "author": [
        "maddox"
      ]
    },
    {
      "name": "github-issue-link",
      "description": [
        "Github issue link looks for #nnn and links to that issue for your default",
        "repo. Eg. \"Hey guys check out #273\"",
        "Defaults to issues in HUBOT_GITHUB_REPO, unless a repo is specified Eg. \"Hey guys, check out awesome-repo#273\""
      ],
      "dependencies": [
        {
          "name": "githubot",
          "version": "0.4.x"
        }
      ],
      "configuration": {
        "description": [
          "HUBOT_GITHUB_REPO",
          "HUBOT_GITHUB_TOKEN",
          "HUBOT_GITHUB_API (optional)",
          "HUBOT_GITHUB_ISSUE_LINK_IGNORE_USERS"
        ],
        "envs": [
          {
            "pattern": "HUBOT_GITHUB_REPO",
            "required": true
          },
          {
            "pattern": "HUBOT_GITHUB_TOKEN",
            "required": true
          },
          {
            "pattern": "HUBOT_GITHUB_API"
          },
          {
            "pattern": "HUBOT_GITHUB_ISSUE_LINK_IGNORE_USERS",
            "required": true
          }
        ]
      },
      "commands": [
        "#nnn - link to GitHub issue nnn for HUBOT_GITHUB_REPO project",
        "repo#nnn - link to GitHub issue nnn for repo project",
        "user/repo#nnn - link to GitHub issue nnn for user/repo project"
      ],
      "notes": [
        "HUBOT_GITHUB_API allows you to set a custom URL path (for Github enterprise users)"
      ],
      "author": [
        "tenfef"
      ]
    },
    {
      "name": "github-issues",
      "description": [
        "Show open issues from a Github repository"
      ],
      "dependencies": [
        {
          "name": "underscore",
          "version": "1.3.3"
        },
        {
          "name": "underscore.string",
          "version": "2.1.1"
        },
        {
          "name": "githubot",
          "version": "0.4.x"
        }
      ],
      "configuration": {
        "description": [
          "HUBOT_GITHUB_TOKEN",
          "HUBOT_GITHUB_USER",
          "HUBOT_GITHUB_REPO",
          "HUBOT_GITHUB_USER_(.*)",
          "HUBOT_GITHUB_API (optional)"
        ],
        "envs": [
          {
            "pattern": "HUBOT_GITHUB_TOKEN",
            "required": true
          },
          {
            "pattern": "HUBOT_GITHUB_USER",
            "required": true
          },
          {
            "pattern": "HUBOT_GITHUB_REPO",
            "required": true
          },
          {
            "pattern": "HUBOT_GITHUB_USER_(.*)",
            "required": true
          },
          {
            "pattern": "HUBOT_GITHUB_API"
          }
        ]
      },
      "commands": [
        "hubot show [me] [<limit> [of]] [<assignee>'s|my] [<label>] issues [for <user/repo>] [about <query>] -- Shows open GitHub issues for repo.",
        "hubot show [me] issues for <repo> -- List all issues for given repo IFF HUBOT_GITHUB_USER configured",
        "hubot show [me] issues for <user/repo> -- List all issues for given repo",
        "hubot show [me] issues -- Lists all issues IFF HUBOT_GITHUB_REPO configured",
        "hubot show <chat user's> issues -- Lists all issues for chat user IFF HUBOT_GITHUB_USER_(.*) configured"
      ],
      "notes": [
        "If, for example, HUBOT_GITHUB_USER_JOHN is set to GitHub user login",
        "'johndoe1', you can ask `show john's issues` instead of `show johndoe1's",
        "issues`. This is useful for mapping chat handles to GitHub logins.",
        "HUBOT_GITHUB_API allows you to set a custom URL path (for Github enterprise users)"
      ],
      "author": [
        "davidsiegel"
      ]
    },
    {
      "name": "github-merge",
      "description": [
        "Integrate with GitHub merge API"
      ],
      "dependencies": [
        {
          "name": "githubot",
          "version": "0.4.x"
        }
      ],
      "configuration": {
        "description": [
          "HUBOT_GITHUB_TOKEN",
          "HUBOT_GITHUB_API (optional)",
          "HUBOT_GITHUB_USER"
        ],
        "envs": [
          {
            "pattern": "HUBOT_GITHUB_TOKEN",
            "required": true
          },
          {
            "pattern": "HUBOT_GITHUB_API"
          },
          {
            "pattern": "HUBOT_GITHUB_USER",
            "required": true
          }
        ]
      },
      "commands": [
        "hubot merge project_name/<head> into <base> - merges the selected branches or SHA commits"
      ],
      "notes": [
        "HUBOT_GITHUB_API allows you to set a custom URL path (for Github enterprise users)"
      ],
      "author": [
        "maletor"
      ]
    },
    {
      "name": "github-pulls",
      "description": [
        "Show open pull requests from a Github repository or organization"
      ],
      "dependencies": [
        {
          "name": "githubot",
          "version": "0.4.x"
        }
      ],
      "configuration": {
        "description": [
          "HUBOT_GITHUB_TOKEN",
          "HUBOT_GITHUB_USER",
          "HUBOT_GITHUB_API (optional)",
          "HUBOT_GITHUB_ORG"
        ],
        "envs": [
          {
            "pattern": "HUBOT_GITHUB_TOKEN",
            "required": true
          },
          {
            "pattern": "HUBOT_GITHUB_USER",
            "required": true
          },
          {
            "pattern": "HUBOT_GITHUB_API"
          },
          {
            "pattern": "HUBOT_GITHUB_ORG",
            "required": true
          }
        ]
      },
      "commands": [
        "hubot show [me] <user/repo> pulls [with <regular expression>] -- Shows open pull requests for that project by filtering pull request's title.",
        "hubot show [me] <repo> pulls -- Show open pulls for HUBOT_GITHUB_USER/<repo>, if HUBOT_GITHUB_USER is configured",
        "hubot show [me] org-pulls [for <organization>] -- Show open pulls for all repositories of an organization, default is HUBOT_GITHUB_ORG"
      ],
      "notes": [
        "HUBOT_GITHUB_API allows you to set a custom URL path (for Github enterprise users)",
        "You can further filter pull request title by providing a reguar expression.",
        "For example, `show me hubot pulls with awesome fix`."
      ],
      "author": [
        "jingweno"
      ]
    },
    {
      "name": "github-search",
      "description": [
        "Tells Hubot to search for anything in code at GitHub"
      ],
      "dependencies": [
        {
          "name": "githubot",
          "version": "0.4.1"
        }
      ],
      "configuration": {
        "description": [
          "HUBOT_GITHUB_TOKEN (optional, if you want to search in private repos)"
        ],
        "envs": [
          {
            "pattern": "HUBOT_GITHUB_TOKEN"
          }
        ]
      },
      "commands": [
        "hubot github search [repo] <query> - Search for <query> in [repo] or anywhere"
      ],
      "author": [
        "spajus"
      ]
    },
    {
      "name": "github-status",
      "description": [
        "Show current GitHub status and messages"
      ],
      "dependencies": [],
      "configuration": {
        "description": [],
        "envs": []
      },
      "commands": [
        "hubot github status - Returns the current system status and timestamp.",
        "hubot github status last - Returns the last human communication, status, and timestamp.",
        "hubot github status messages - Returns the most recent human communications with status and timestamp."
      ],
      "author": [
        "voke"
      ]
    }
  ],
  "devops": [
    {
      "name": "devops-hook",
      "description": [
        "Devops hooks script"
      ],
      "dependencies": [],
      "configuration": {
        "description": [
          "HUBOT_DEVOPS_USER (optional)",
          "HUBOT_DEVOPS_PASS (optional)",
          "HUBOT_DEVOPS_REPO (optional)",
          "HUBOT_DEVOPS_AUTH_API (optional)"
        ],
        "envs": [
          {
            "pattern": "HUBOT_DEVOPS_USER"
          },
          {
            "pattern": "HUBOT_DEVOPS_PASS"
          },
          {
            "pattern": "HUBOT_DEVOPS_REPO"
          },
          {
            "pattern": "HUBOT_DEVOPS_AUTH_API"
          }
        ]
      },
      "commands": [
        "hubot devops list - list all hooks",
        "hubot devops register <id> <url> <data> - register a hook",
        "hubot devops remove <id> - remove a hook",
        "hubot devops run <id> - run a hook"
      ]
    },
    {
      "name": "devops-post",
      "description": [
        "Fire a post request to a url endpoint"
      ],
      "dependencies": [],
      "configuration": {
        "description": [
          "HUBOT_DEVOPS_POST_URL (optional)"
        ],
        "envs": [
          {
            "pattern": "HUBOT_DEVOPS_POST_URL"
          }
        ]
      },
      "commands": [
        "hubot post <data>          - post data(json string) to the pre-configuraed url",
        "hubot post <data> to <url> - post data(json string) to the given url"
      ]
    }
  ]
}