hubot-ibmcloud-deploy

Script package that application deployment to the IBM Cloud through Hubot.

Getting Started

• Usage
• Commands
• Hubot Adapter Setup
• Cognitive Setup
• Development
• License
• Contribute

Usage

If you are new to Hubot visit the getting started content to get a basic bot up and running. Next, follow these steps for adding this external script into your hubot:

1. cd into your hubot directory

2. Install this package via npm install hubot-ibmcloud-deploy --save

3. Add hubot-ibmcloud-deploy to your external-scripts.json

4. Add the necessary environment variables:

    HUBOT_BLUEMIX_API=<Bluemix API URL>
    HUBOT_BLUEMIX_ORG=<Bluemix Organization>
    HUBOT_BLUEMIX_SPACE=<Bluemix space>
    HUBOT_BLUEMIX_USER=<Bluemix User ID>
    HUBOT_BLUEMIX_PASSWORD=<Password for the Bluemix use>
    HUBOT_GITHUB_TOKEN=<GitHub personal access token> (optional)
   

   HUBOT_GITHUB_DOMAIN=<GitHub domain, omit for public GitHub> (optional)

5. Start up your bot & off to the races!

Commands

• hubot deploy - Deployment setup with prompts for application, GitHub URL and branch.
• hubot deploy <app> - Deployment setup for app, or prompt you to provide a GitHub URL and branch to depoy to.
• hubot deploy <url> - Deployment setup for url and prompt you for the Bluemix application name and branch.
• hubot deploy <app> <url> - Deployment of app with url, prompt for branch if not provided.
• hubot deploy help - Show available commands in the deploy category.

Your github repository should contain a manifest.yml that describes the deployment of the application. More information about application deployment and manifest files can be read here: https://console.ng.bluemix.net/docs/manageapps/depapps.html#deployingapps

Hubot Adapter Setup

Hubot supports a variety of adapters to connect to popular chat clients. For more feature rich experiences you can setup the following adapters:

• Slack setup
• Facebook Messenger setup

Cognitive Setup

This project supports natural language interactions using Watson and other Bluemix services. For more information on enabling these features, refer to Cognitive Setup.

Development

Please refer to the CONTRIBUTING.md before starting any work. Steps for running this script for development purposes:

Configuration Setup

1. Create config folder in root of this project.

2. Create env in the config folder, with the following contents:

    export HUBOT_BLUEMIX_API=<Bluemix API URL>
    export HUBOT_BLUEMIX_ORG=<Bluemix Organization>
    export HUBOT_BLUEMIX_SPACE=<Bluemix space>
    export HUBOT_BLUEMIX_USER=<Bluemix User ID>
    export HUBOT_BLUEMIX_PASSWORD=<Password for the Bluemix use>
    export HUBOT_GITHUB_TOKEN=<GitHub personal access token> (optional)
   

   export HUBOT_GITHUB_DOMAIN=<GitHub domain, omit for public GitHub> (optional)

3. In order to view content in chat clients you will need to add hubot-ibmcloud-formatter to your external-scripts.json file. Additionally, if you want to use hubot-help to make sure your command documentation is correct. Create external-scripts.json in the root of this project, with the following contents:

    [
      "hubot-help",
      "hubot-ibmcloud-formatter"
    ]
   

4. Lastly, run npm install to obtain all the dependent node modules.

Running Hubot with Adapters

Hubot supports a variety of adapters to connect to popular chat clients.

If you just want to use:

• Terminal: run npm run start
• Slack: link to setup instructions
• Facebook Messenger: link to setup instructions

License

See LICENSE.txt for license information.

Contribute

Please check out our Contribution Guidelines for detailed information on how you can lend a hand.