Getting Started

Take a look at this doc to get an overview of what GitBot does.

Tracking your repository/organization with gitbot

Making a pull request (preferred method)

PRs are automatically merged if the tests pass. You can watch this video to learn how to add a repo, and to see how PRs are checked & merged. To track your repository with gitbot, follow the steps below:

1. GitHub Permissions: Ensure the cf-gitbot github user has administrator permissions on the repository you wish to track. Gitbot requires the Admin role so that we can create webhooks and tags.

   • On GitHub, navigate to the main page of the repository.
   • Under your repository name, click Settings.
   • In the left sidebar, click Collaborators & Teams.
   • Under Collaborators section, ensure the cf-gitbot appears with administrator permission, otherwise add it. We auto-accept all invites at the top of each hour.
   • NOTE: Gitbot will not work on "User" repos.

2. Tracker Permissions: Ensure cf-gitbot (cfaccounts+cfgitbot@pivotallabs.com) is an owner on the Pivotal Tracker project you wish gitbot to add stories to. This is so that GitBot can create webhooks on your Pivotal Tracker project.

3. YML File Edits: Edit the config-production.yml file here to add in your repository

   • Search for your tracker ID to see if it already exists. If the tracker ID is already in the configuration file, add in the repository under that project ID by specifying the org and repo as shown below.

   If the tracker ID is not there, add in a new project_id section.

   For example, if we wish to add the repository https://github.com/test_org1/test_repo1 and map it to the tracker 123456 which was not specified, we would need to add the following lines

   - project_id: 123456 team_name: Test Tracker Project repos: - test_org1/test_repo1

4. Send your changes in for auto-testing:

   • Modify config-production.yml
   • Create a new branch --> Propose file change --> Create pull request
   • Our automation will test your changes
     • You can view the pipeline here
     • If the pipeline fails, double check the permissions. We will re-trigger the pipeline if we find any new repo invites at the top of each hour.

5. Wait 1 hour

   • The new webhook will be created for you if everything was set up correctly.
   • If you attempt to create the webhook manually, it will never work ;-)

Removing cfgitbot integration

Removing a Github repository for a Tracker project:

1. Edit the config-production.yml file to remove your repository, and make a pull request.
2. After the PR is successfully merged, remove the webhook from your Github repository.

Removing a Tracker project:

1. Edit the config-production.yml file to remove your repository, and make a pull request.
2. After the PR is successfully merged, remove the webhook from your Tracker project.

E-mailing/Slacking the Toolsmiths

If you do not have a team member with access to the cfgitbot-config repo, we can take your requests for changes via email or slack at #cf-toolsmiths