App for GitHub

for an overview of git integration options, see docid\ mojnar9m 9n0 epkhbpys this guide explains how to connect resolve ai with github resolve uses this connection to understand your codebase and use that context in investigations resolve ai supports all github plans free, pro, team, and enterprise cloud follow the steps outlined docid 7wysre9xiydjgzeubm8yi for setup if you are using github enterprise server, please use the dedicated instructions docid 7wysre9xiydjgzeubm8yi prerequisite to install the resolve app for github, you need to start by logging in to your resolve ai account, then going to the integrations page how it works resolve ai integrates with github through a secure, github native mechanism a github app once installed github automatically issues a short lived installation token per request you never manage or rotate personal access tokens (pats) resolve ai handles token lifecycle and refresh behind the scenes the agent pulls in relevant code, commits, and pull requests as part of an investigation to help you quickly zero in on the root cause resolve ai pulls in code and prs into investigations and tells you where the problem lies you can ask questions that span your telemetry and your codebase , and resolve ai connects the dots for you connect resolve ai to github log in to the resolve ai app at https //app0 resolve ai/ open the https //app0 resolve ai/integrations/github page create a new integration, add a name and click install application in github, pick all or subset of your repositories in the dropdown and click save select a github repo connect resolve ai to github enterprise server for self hosted instances of github, install the resolve application and provide permissions in the resolve integration ui create an app in your github enterprise server 1\ register a new github app log in to your github enterprise server account navigate to your organization's main page in the left sidebar, click on settings click developer settings > github apps click to register new github app github app name resolve ai homepage url https //resolve ai/ 2\ enable repository permissions enable the following repository permissions as access read only commit statuses contents deployments issues merge queues metadata pull requests 3\ collect app id and private key capture credentials and generate a private key for the app app id private key github app credentials 4\ install the app in your organization and get the installation id after creating the resolve ai app, install it in your organization then get the installation id from the url github com/organizations/\<your org name>/settings/installations/``\<installation id> for example, in the below screenshot the installation id is "84995228" installation url 5\ get your base url when using github enterprise server version 2 5 or later, set options baseurl to the root api url for example, if your github enterprise server hostname is github acme inc com, then https //github acme inc com/api/v3 will be your base url if you are using an older version of github enterprise server or have manually overridden the base url, contact your github administrator for the correct value enable the integration in resolve ai set up the integration either through the resolve ui (for github enterprise servers accessible over the public internet) or by configuring it in satellite connect via resolve ui open the https //app0 resolve ai/integrations/githubenterprise/connect in resolve ai click add connection enter a name (ex my github ) leave environments blank to connect your code for environments, or list specific ones that match your satellite config enter your docid 7wysre9xiydjgzeubm8yi paste your docid 7wysre9xiydjgzeubm8yi and docid 7wysre9xiydjgzeubm8yi click save connect via resolve satellite 1 create a kubernetes secret create a kubernetes secret of the following form note that the structure of the secret is important and for a github enterprise server private key secret creation apiversion v1 kind secret type opaque metadata name github resolve pvt key stringdata privatekey | "< begin rsa private key >" to apply the secret, run apply secret kubectl apply f github resolve pvt key yml 2 configure the resolve satellite to connect to github enterprise server add the github enterprise integration to resolve values yaml , using the docid 7wysre9xiydjgzeubm8yi , docid 7wysre9xiydjgzeubm8yi and docid 7wysre9xiydjgzeubm8yi resolve values yaml integrations github type "githubenterprise" create true secretname "github resolve pvt key" connection baseurl "\<your github enterprise server url>" appid "\<your resolve ai github app id>" installationid "\<your resolve ai github installation id>" 3 apply changes update the satellite with the new resolve values yaml file helm upgrade install resolve satellite \\ oci //registry 1 docker io/resolveaihq/satellite chart \\ \ values resolve values yaml 4 verify integration open https //app0 resolve ai/integrations/githubenterprise/connect in resolve ai and check the connection frequently asked questions how does resolve ai’s github integration work? the integration is installed as a github app you install the app on any repository you want resolve ai to read github issues a short lived installation access token automatically for each request, so you never manage or rotate pats yourself all token lifecycle and refresh logic is handled by resolve ai behind the scenes what data does it look at? during an investigation the agent reads, but does not write the scope is limited to repository tree (file paths and file contents) pull / merge requests (open and merged) commit metadata and diffs basic repository metadata (default branch, topics, permissions) issues, projects or discussions are not accessed unless you explicitly grant those additional scopes does resolve ai store the source code? no source code is streamed from github at runtime only and is not persisted or mirrored on resolve ai’s servers the sole exception is small code snippets that appear in your investigations which are saved in resolve ai saas or sent to slack can resolve ai make changes to my repositories? no the github app is granted read only permissions it cannot push commits, open pull requests, merge code, or alter repository settings you can review the precise permission set during installation or on the resolve ai github app at any time i'm using a https //docs github com/en/enterprise cloud\@latest/organizations/keeping your organization secure/managing security settings for your organization/managing allowed ip addresses for your organization how do i connect with resolve? contact our support team, mailto\ support\@resolve ai , to manage the allowlist of ip addresses for resolve ai to connect to your github organization