Integrating with GitHub
With the GitHub integration, you can easily track your members profile and activities in your GitHub community and see how they are engaging with your your repos. You can identify top contributors, members who have recently become inactive, and which repos are the most popular in your community.
- You must have your own Github user account
- A Personal Access Token from Github.
- When you are creating your token, we recommend the following settings:
- Expiration - None
- Scopes - Repo, User
- Check public repositories
- Check User and user emails
- If you are going to follow a private repository, check private repositories.
Install the GitHub Integration
- In your Commsor account, select Settings in the main navigation bar, and then select Integrations from the settings side menu.
- Select Connect under the GitHub Public integration box.
- Enter your GitHub Public Personal Access Token credential and the name of the GitHub User or Organization you wish to integrate with, then select Connect. Your Commsor account is now integrated with Github, and can receive information through your Github account to be displayed and analyzed in Commsor.
- Scroll through the dropdown menu to select the available repositories you'd like to connect. You can connect to them one by one and track multiple repositories.
- Your GitHub integration is now active! You can view the member, profile, and activity feed information as it is loaded in (may take a few minutes).
How to use your Github Integration
The Github integration brings the member and activity information from the repositories you track into your Commsor dashboard. You’ll be able to see who your top contributors are and see who is starring your repositories to following along. Paired with other integrations, you can get a full picture of who your community is, how they’re connected, and insight on how it can grow.
The Github integration will pull the following information and display it in your member profiles and activity feeds.
- Issue Opened
- Pull Request Opened
As the information is added to your member profiles, you can make decisions about how to engage and manage your Github Community!
To only view the members who are in the public repositories you are tracking:
- Go to your Community page
- Select the Filter button on the top right of your page
- Select Add Filter
- Select the Property Value down arrow, and choose a filter that includes Github Public in the title, such as Github Login (Github Public), then a corresponding field such as Is not empty. Then select View Results.
Can you track a private repo with this Github app?
You can track any private repos you are a member of. To do so, before generating the Personal Access Token that you use to install the integration with Commsor, check that setting within your Token settings menu. After connecting your Github app, the private repos you are a member of will also appear in the menu of available repos you can connect to.
How do I disconnect a repository or my entire Github integration?
- To navigate to the menu where you can disconnect your repositories or app, select Learn More next to the Github Public app in your integrations menu.
You can disconnect any individual Github repository by selecting Disconnect next to the repository. If you disconnect a repository, the information will continue to live in your Commsor account, it just won’t pull any updates to member data or activity. If you choose to reconnect that repository in the future, it will fill in the data from the period which it was disconnected.
- To disconnect your Github app entirely, select Disconnect on the bottom right corner. When you Disconnect your entire app, you have the option to keep the data that was collected in Commsor OS, or delete everything that had been collected up to that point.
The only way to delete information from an individual repository is to disconnect the entire Github integration, then re-integrate without that repository.