This document is a step by step guide for setting up the GitHub integration within BrightGauge.
Step 1 - Log in to your BrightGauge Account
If you haven’t created an account yet, go here to get started.
If you are logged in with a New Account:
From the account Overview page, click on the "Add a Datasource" button:
If you are logged in with an Existing Account:
Click on the "Data" menu at the top righthand corner of the screen, and select "Datasources" from the drop down menu:
Find the GitHub datasource under "All" or under the appropriate category:
Step 2 - Authenticate with GitHub
Now we need to authenticate with GitHub.
- Click on the Authorize in GitHub button at the center of your screen.
- If you're not currently logged into GitHub, they'll ask you to login. If you are, proceed to step III
- Authorize BrightGauge to speak with GitHub
- Once authenticated, the window will close and a successful test connection will show in BrightGauge.
- Name the datasource (by default it will say GitHub Api) and make sure to click save at the bottom left. IF you do not save the datasource, you will have to redo all steps.
Dashboards, reports, datasets, and gauges will be added to your account after the datasource is saved. They will start syncing immediately and typically complete syncing after 20-30 minutes.
Your Default Dashboards
- BGS - Developer Dashboard
Your Default Reports
- Developer Report
For a list of all default gauges, please visit the "Gauges" section of your account, sort by the Datasource you'd like to see and select for Default.
If you have any questions, don't hesitate to ask us at email@example.com.
- Pull Requests: List of all pull requests for your organization and their respective attributes (e.g. Name, State, Base and Head Ref, etc).
- Organization Repositories: List of all repositories for your organization and their respective attributes (e.g. Name, Description, Open Issues Count, etc).
- Repository Events: List of all your organizations events and their respective attributes (e.g. Event Type, Commit URL, Issue Number, etc).
- Repository Issues: List of all of your organizations issues and their respective attributes (e.g. Assignee, Comments, State, etc).
- Repository Branches: List of all branches for your organization and their respective attributes (e.g. Name, Last Commit, Commit Message, etc).