NOTE: Certain information in this article may be missing or out of date. We are in the process of updating the content.
With GitHub, developers can discover, use, and contribute to projects using a powerful, collaborative workflow. You can also integrate GitHub with third-party tools to help you build software your way. A GitHub/Grow integration allows you to unify and visualize your GitHub data, so you can manage projects more effectively.
NOTE: We are no longer actively supporting this integration as of April 2019. If you have previously authenticated this data source, it will still appear in the list of your data sources. We will not be improving this integration further.
How to Connect
Before you get started you will need your Github login credentials.
- Log in to Grow and select Add Metric. From the list of data sources, select GitHub, then select Connect.
- This will bring you to a sign-in page for GitHub. Go ahead and log in to your GitHub account.
- After you sign in, there will be a page to “authorize application.” Go ahead and click the Authorize Application button at the bottom of the page.
And that's it! You are good to go.
Below are the reports available from GitHub, along with a short description of the data each one returns. All data from GitHub is specific to a selected repository.
- Contributors: Names of assignees, their weekly additions, deletions, and commits.
- Issues: List of specific issues listed by repository, assignee, date created, date closed, status, etc.
- Repositories: List of repository information, size, number of issues, forks, watchers, etc.
FAQs + Tips and Tricks
GitHub has some specific terminology they use. Here are some of the keywords and what they mean.
- Repository: Essentially a project where a team of developers are collaborating on code.
- Commits: A commit command transactionally saves the pending additions to the local repository.
- Additions: Additions to a repository
- Deletions: Deletions in a repository
Grow uses Github V1
Grow currently uses the Github v1 package. This means that many of the relational values associated with the report objects (Issues, Repositories & Contributors) are not yet available in Grow.
Dates Pull Based on Updated At vs. Created At
When you pull information into Grow from GitHub, the dates might not look right. Let’s say you pull data from 30 days back, but Grow is showing data from a couple years back.
The way GitHub's API is set up, we are only able to filter records based on the updated date. This means that some records that have been updated in the last 30 days will show up, even though they were created several months ago.
If you don't want to see any records created prior to 30 days, you can apply the filter in Grow's edit metric screen to limit the created date to 30 days. Unfortunately, there is no other way to do this direct from the GitHub API. See what GitHub shows on their API documentation.