GitHub
Setting up the GitHub Integration
Our GitHub integration enables search and answer features by connecting issues, comments, discussions and pull requests from your repositories to our platform. This guide will walk you through the setup process.
Features
Search: This integration indexes issues, comments, discussions, and pull requests to enhance search results and answers, helping your team find the right information when they need it.
Configuration Steps
Add your organization's GitHub account name to Convictional An admin can do this from your organization settings Your organization's GitHub account name is case sensitive, please ensure it is correct before continuing with the configuration process.
Install the Convictional GitHub Application Install the Convictional GitHub Application to the organization you configured in step 1.
Select which repositories to include During the installation of the Convictional GitHub application, you will be prompted to select which of your organization's repositories you want to make available to Convictional. You can also change this configuration after installation via the GitHub Apps settings in your GitHub organization settings.
Verify the Installation Once you have installed the application in GitHub, go back to your organization settings You should see "connected" in the GitHub configuration section.
Disconnecting Convictional from GitHub
To disconnect Convictional from your GitHub account, simply suspend or uninstall the application in GitHub. The status of our integration will be reflected in your organization settings.
Disconnecting the application, or revoking access to a specific repository, will not remove previously indexed GitHub content from Convictional. If you need to remove content indexed from GitHub, please contact our support team.
Ingestion Frequency
The GitHub integration indexes content from GitHub hourly. This means that it may take up to an hour for content to be available in search.
Code Security
Convictional is not granted permission to view code, and does not index code for search or any other feature.
Need Help?
If you encounter any issues during setup, reach out to our support team and we'll be happy to help.
Last updated