GitHub Integration

Contents

What does it do?

The GitHub integration allows GitHub users to track development work and their activity to automatically drive progress on their objectives in Betterworks.

How does it work?

Note: This integration is for the web version of GitHub (github.com). As such, users will not be able to connect to an Enterprise edition.

Using authentication to a user's individual GitHub account, a Betterworks user has access to any of their GitHub organizations or repositories and can use filters to locate specific pull requests or issues to integrate and track progress on in Betterworks. 

How is it set up?

As long as an administrator has enabled the GitHub integration, the option will be available to all users in the objective creation/edit page. Administrators with Super Admin permissions can enable the Github integration by going to:

Admin→ Platform Configuration→ Integrations → Third-party integrations → Github → Enable

1.png

Then toggle the switch on:

2.png

When a user is on the objective creation/edit page, they can simply click the Github icon:

3.png

Then click again to sign in:

4.png

Once signed in, the first filter must be used to select either an Organization or a Repository to which the account access in order to see either Pull Requests or Issues in the results field

Note: A single key result cannot be integrated with items across different Organizations or Repositories. 

5.png

Once the first filter has been defined, users are able to set a list of custom filters from which they can manually select issues/requests. Alternatively, they can choose to "Sync all issues" so that the filters chosen define a dynamic list of requests or issues to track in Betterworks. As issues are closed and pull requests are either merged or closed, progress will be reflected in Betterworks.