Rally Bot GitHub App Integration Installation and Setup

The Rally Bot GitHub App Integration allows developers to connect Rally user stories and defects to pull requests in GitHub.
This feature is currently in Beta.
Install the Rally Bot GitHub App Integration
This integration is installed within GitHub. 
Follow these steps:
  1. As a Rally Subscription Administrator, find your subscription ID. Learn more. 
  2. As a Rally Administrator, create a new API key in Rally, with 
    Full Access
    .
    1. To access the 
      Rally
       Application Manager, log in with your 
      Rally
       username and password at the following URL:
    2. Select the 
      API Keys
       tab.
    3. Select the 
      Create New API Key
       link. 
      External API Keys
       
    4. Enter a name or description for the key in the 
      Description
       field.
    5. Select the read-only or full access option from the 
      Grants
       section.
    6. Select 
      Create
      .
      Your key is created and you can edit or delete the key as needed. 
      API Keys
       
  3. Copy the newly-created API key. 
  4. Go to the Rally Bot GitHub App Integration home page (https://rally1.rallydev.com/apps/github-app/home). 
  5. Select 
    Setup Integration
    .
  6. Install Rally Bot on your GitHub organization.
    Installation Permissions: GitHub Organization Owner or GitHub App Manager permissions. You can check to see if you have the required permissions by going to 
    https://github.com/organizations/{Your Organization Name}/settings/installations
    . If you do not have access, you can request to become an App Manager from your GitHub Organization owner.
    1. Select repositories. 
    2. Review the permissions. These are required by Rally Bot, and are compliant with GitHub App security policies. Learn more. 
      Rally Bot permissions
       
    3. Select 
      Install
      .
  7. On the Finish Setup page:
    1. Enter your 
      Rally Subscription ID
      .
    2. Enter your 
      Rally API Key
      . We recommend copying the API key that you created earlier and pasting it here.
    3. Select 
      Complete Setup
      .
  8. The Success! page indicates that your Rally Bot GitHub App has been successfully installed.
Update the Rally Bot GitHub App Integration Settings
You may update your GitHub repositories or the Rally Bot settings (Subscription ID or API Key).
Follow these steps:
  1. Select 
    Configure Integration
     (at the top right).
  2. Select 
    Configure
    .
  3. Make any changes to the GitHub repositories (select/deselect, select all).
  4. Select 
    Save
    . This saves the GitHub changes, and directs you to the Rally Bot setup.
  5. To edit your Rally Subscription ID, select 
    Enter New Subscription ID
     and enter the new value.
  6. To edit your Rally API Key, select 
    Enter New API Key
     and enter the new value.
  7. Select 
    Submit Changes
    . This saves the Rally Bot changes.
Remove the Rally Bot GitHub App Integration
You can uninstall the Rally Bot.
After you remove the Rally Bot:
  • The Rally API key is removed.
  • Every connection between Rally and GitHub still works (previously connected work remains linked).
  • New connections cannot be added.
Follow these steps:
  1. Select 
    Configure Integration
     (at the top right).
  2. Select 
    Configure
    .
  3. Scroll to the bottom of the page and select 
    Uninstall
    .