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 that shows the same feature in the Classic user interface.
Contents
Overview
Note: This integration is for the web version of GitHub (github.com). Users will not be able to connect to an Enterprise edition.
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
1. In Betterworks, access the Third-party page.
- Click Admin on the top banner menu.
- Select the Program Configuration header from the left panel.
- Select Integrations.
- Select the Third-party tab.
2. Scroll down to GitHub and expand the section.
3. Click the toggle to enable the integration.
Connecting Milestones
Once the integration has been configured, any user in the organization can use it.
1. Access GitHub.
- Click Goals on the top banner menu.
- Click Create Goal on the Goals page.
- Enter a goal.
- Click into the milestone field.
- Click the GitHub icon under Integration on the right panel.
2. Click the GitHub icon to sign in.
3. Enter the requested credentials.
4. Click Sign in.
5. Make your selections.
- Once the first filter has been defined, you'll be able to 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.
6. Click Save.
Note: A milestone cannot be integrated with items across different organizations or repositories.
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 sub-set 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.