Hubot Pipeline Steps

Table of Contents

• Default Site optional, default to false. Default at folder level or Global level, when there are multiple default sites at the same level (Global or at a certain folder level), randomly picked.

• Name required, site name.

• URL required, hubot url, including port number, Ex: https://localhost:9999/.

• Room optional, room name, which can include #, depends on the chat service. Is optional when using folder name as room option.

• Use Folder Name as Room optional, by default is false, use folder name as room name.

• Room Prefix optional, only applicable for folder name as room option enabled. Ex: For personal organization folder @ required to send direct messages.

• Fail On Error optional, default true.

• Advanced

  • Build Notifications optional - List of build notifications.

    • Enabled - Enable this notification.

    • Type - List of available build notifications.

    • Room(s) - optional, list of rooms, comma separated, when it is different from actual room name above.

    • Token(s) - optional, list of tokens, comma separated, refer to Token Macro plugin for more info. Ex: 'BUILD_DURATION, BUILD_URL'. NOTE: no ${} around token name.

• List of Global Hubot Sites

• List of Hubot Sites

• Enable Notifications - defaults to false.

• Hubot Site Name optional, given there is a default site at folder(or one of the parent folders) level/ global level.

Sends a given message to site/room.

• message required, actual message to send.

• status optional, text which can be used in script to differentiate. Ex: INFO, WARN, ERROR or SUCCESS - So that in Slack it can be used to decide card colors.

• tokens optional, list of tokens, comma separated, Refer to Token Macro plugin for more information.

• extraData optional, extra data like attachments in case of slack, Any kind of Map, given it is Serializable.

• site optional, hubot site name either it is from Folder Level or Global Level, Only used when url is not present. Optional, it will fallback to first default site that it found while searching from immediate folder to Global site configurations.

• url optional, if it is provided as global environment variable HUBOT_URL or provided by withEnv step, this should always end with /, environment variable takes the lower precedence.

• room optional, if it is provided as global environment variable HUBOT_DEFAULT_ROOM or provided by withEnv step, and room doesn’t require #, it is added in the code, environment variable takes the lower precedence.

• failOnError optional and by default it is true, if any error it won’t abort the job, it can also be provided as global environment variable HUBOT_FAIL_ON_ERROR, environment variable takes the lower precedence.

Sends a hubot message the project chat room for a project when the build is waiting for user input with the hubot commands to proceed or abort the build.

• message required, actual message to send.

• status optional, text which can be used in script to differentiate. Ex: INFO, WARN, ERROR or SUCCESS - So that in Slack it can be used to decide card colors.

• tokens optional, list of tokens, comma separated, Refer to Token Macro plugin for more information.

• extraData optional, extra data like attachments in case of slack, Any kind of Map, given it is Serializable.

• site optional, hubot site name either it is from Folder Level or Global Level, Only used when url is not present. Optional, it will fallback to first default site that it found while searching from immediate folder to Global site configurations.

• url optional, if it is provided as global environment variable HUBOT_URL or provided by withEnv step, this should always end with /, environment variable takes the lower precedence.

• room optional, if it is provided as global environment variable HUBOT_DEFAULT_ROOM or provided by withEnv step, and room doesn’t require #, it is added in the code, environment variable takes the lower precedence.

• failOnError optional and by default it is true, if any error it won’t abort the job, it can also be provided as global environment variable HUBOT_FAIL_ON_ERROR, environment variable takes the lower precedence.

• id optional, defaults to Proceed, refer to input step for more information.

• submitter optional, comma separated list of users who can provide input. Refer to input step for more information.

• ok optional, Proceed button label, Refer to input step for more information.

• submitterParameter optional If specified, this is the name of the return value that will contain the ID of the user that approves this input. Refer to input step for more information.

• parameters optional, Request that the submitter specify one or more parameter values when approving. Refer to input step for more information.

Refer to hubot-base to setup a either docker container or to run it locally.

💡	Please replace scripts on hubot-base repo with the scripts under this hubot-steps repo and it is always a good idea to copy over the scripts from appropriate tag based on the version being installed on Jenkins.

Then just copy over following scripts from scripts folder (jenkins, and one of the hubot scripts based on chat service you are using.). These are just examples and can be modified based on chat service / per the actual needs.

• hubot_slack

• hubot

• jenkins

Screenshot: