GitHub
Last updated
Last updated
Overview
GitHub is a renowned platform for hosting and versioning code, facilitating collaboration among developers. Leverage the power of GitHub's vast repository data within Rely.io for a comprehensive view of your software life-cycle.
During the configuration process, you'll be asked to install and authorize the Rely.io GitHub App. This app will require specific permissions in your account for the plugin to function properly: Read
✅ Actions
✅ Code
✅ Issues
✅ Members
✅ Metadata
✅ Pull Requests
✅ Workflows
Write
✅ Workflows
The necessary permission scopes will be automatically filled in for you so you don't have to worry about that.
Installing applications in GitHub organizations require administrator permissions. Make sure you have them or request support from your GitHub organization owner.
Go to your Rely.io organization and start by navigating to the data sources page.
Click the "Add Data Source" button and select "Github".
You'll be redirected to GitHub App's integration form. Login to your GitHub account.
Install the application in your organization. This action requires administrator access in the GitHub organization.
You'll be redirected back to the Rely.io.
Provide an expressive name to this integration that allows you to easily identify the source, and click "Submit".
To prevent pulling outdated or stale data from your tools and flooding your catalog with unactionable entities, our plugins are set by default with policies to reduce noise.
For instance in the case of Git providers:
Repositories with no activity over the last 3 months are ignored
Repositories that have been archived are also ignored
All entities related to ignored repositories (Pull Requests, Issues, Deployments, etc.) are consequently ignored
To learn more about these policies and how to customize them, read our related article in our FAQ.
After you add the GitHub plugin, an entity discovery run will be triggered. The initial discovery run can take up to a few minutes. By the end of this discovery run:
New blueprints will be added to your data model
Entities retrieved from the data source will be added to the Discovery page for you to either approve or reject them
The plugin periodically updates all retrieved entities to ensure they stay in sync with their external counterparts.
Once the initial discovery run completes successfully you should see your GitHub plugin under the Active section of the data sources page.
The next step is to get the GitHub entities synced into your Service Catalog. Check our official guidance on how to do it.
