GitHub Integration (NextGen)

Note: The following article shows the NextGen user interface. If the steps and/or screenshots do not match what you see in your organization's Betterworks instance, try this article, which shows the same feature in the Classic user interface. 

Contents

• Overview
• Configuration
• Connecting Milestones
• Data Sync
• Troubleshooting
• FAQs

Overview

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

With authentication from their individual GitHub account, a user has access to any of their GitHub organizations or repositories from within Betterworks. Users can employ filters to locate specific pull requests or issues to integrate and track progress in Betterworks.

Configuration

Note: The integration only works with the web version of GitHub (github.com).

1. Click Admin (bottom of the left-side panel). 
   
   
    
2. Click Platform Configuration. 
3. Select Integrations. 
4. Click Third-party (top-left tab). 
5. Scroll down to GitHub. 
   
   
    
6. Click the toggle to Enable the integration. 
   
   

Connecting Milestones

Once the integration has been configured, any user in the organization can use it.

1. Click Goals (in the left-side panel).
2. Enter a goal. 
3. Enter a milestone. 
4. Click to expand Progress Settings. 
5. Click Connect on the GitHub tile. 
6. Click Sign In. 
7. Enter your credentials. 
8. If you encounter an access request, click Accept or the applicable option.
9. Connect to your repository. 
10. Make your item selections. 
    1. You can set a list of custom filters from which to manually select issues/requests. Or, you can choose to Sync all issues so that the filters chosen define a dynamic list of requests or issues. As issues are closed and pull requests are either merged or closed, progress will be reflected in Betterworks.
11. Click Save. 

Data Sync

• Automatic Sync: Automatically updates the progress of your milestones in Betterworks every hour.
• Manual Sync: To manually sync the progress on your milestones: 
  • Go to My Goals.
  • Select the relevant goal.
  • Click the three horizontal dots.
  • Select Sync from the drop-down menu. 

Note: You may need to refresh your internet browser as well to see the changes reflected.

Troubleshooting

If progress is not updating check if progress locking is on. Progress locking is a subset of goal locking and extends to milestones connected to third-party applications through our various integrations. If your milestone is connected to GitHub, any progress made in GitHub will not impact the milestone when progress locking is on.

FAQs

Can I integrate with multiple organizations or repositories?

No. A single milestone can only be integrated with items from a single organization or repository. Ensure that you select the appropriate organization or repository during the configuration.

What should I do if the integration is not capturing the expected data?

Ensure that the filters you've set up accurately reflect the pull requests or issues you'd like to track. If necessary, adjust the filters to capture the desired data.