Skip to main content

Github

The GitHub connector facilitates integration with GitHub repositories and actions, allowing seamless automation and data interaction. It enables tasks like creating issues, managing repositories, and automating workflows directly from your applications.

Configuring API Connector in DronaHQ

Add a Account name. Then click Save, it will open a pop-up window asking you to sign-in into your GitHub account. Continue with the steps and give access to DronaHQ to connect with your GitHub ID and its information.

Sign-in to your GitHub account
Sign-in to your GitHub account

After successfully configuring and saving the connector settings, you can easily access your newly connected account by navigating to the connected accounts list. You can find this option from the Connector -> Manage Account section. This centralized location allows you to conveniently monitor and manage your connected accounts.

Supported API endpoints

ActionDescription
GetProfileRetrieve user's profile details.
GetUserReposGet a list of repositories owned by a user.
ListAllOrganizationsFetch the list of organizations a user belongs to.
CreateGistCreate a new gist (code snippet) on GitHub.
GetRepoUsersRetrieve a list of users who have access to a repository.
CreateIssueCreate a new issue in a repository.
GetAllLabelsFetch all the labels available in a repository.
GetIssueListGet a list of issues from a repository.
UpdateIssueUpdate the details of an existing issue.
CreateCommentAdd a new comment to an issue or pull request.

Self-Hosted Installation

To use the GitHub Connector on the on-prem version, follow these steps:

  1. Select the Connector: Choose the GitHub Connector from the list.

  2. Provide the Necessary Details:

  • Environment/Account Name: The name can contain alphanumeric characters, must start with an alphabet, and can include _ as a special character, but should not contain spaces.

  • API Base URL: Enter https://api.github.com as the base URL of your API endpoint.

  • OAuth Redirect URL: Copy the following URL. Use this link in your app's API or developer settings to create a new integration or app to use with DronaHQ. If required, go to your app's admin console and add it to the allowed list.

Obtaining GitHub API Credentials

  1. Client ID and Client Secret: Obtain these unique credentials by registering your application in the GitHub Developer Console.

  2. Scope: Define the specific functionalities your application needs access to within GitHub. Choose appropriate scopes from the GitHub documentation.

  3. Authorization URLs: Refer to the GitHub OAuth documentation for the Authorization Request URL, Access Token Request URL, and Refresh Token Request URL.