Connect GitHub

A GitHub connection lets Faustine read the repositories it analyzes. You create it in the Connect your code step when you create a Web Agent or create an API, and every later agent or API in the workspace can reuse it.

What Faustine can access

The Faustine GitHub App asks for read-only access to the contents of the repositories you choose when you install it. Faustine uses that access to clone the repository for analysis, to list repositories, branches and folders in the wizard, and to show files in the Advanced editor. It does not write to your repositories.

With the app, Faustine stores no secret for the connection. It requests a short-lived token from GitHub each time it needs to read. With a personal access token, Faustine stores the token encrypted and its access is whatever the token allows.

Connect with the GitHub App

To connect a GitHub account or organization:

1. In the Connect your code step, select GitHub.
2. Select Connect GitHub. The browser goes to GitHub.
3. On GitHub, choose the account or organization, choose the repositories Faustine can read, and install the app.
4. If GitHub asks you to authorize the app, authorize it. Faustine uses this to confirm that you have access to the installation.

GitHub sends you back to the wizard with the new connection selected. It appears under GitHub connections as GitHub App with the account's name.

To change which repositories the app can read, change the app's repository access in your GitHub settings. See Reviewing and modifying installed GitHub Apps.

Connect with a personal access token

Use a token when you cannot install the app on the account that owns the repository.

1. Create a personal access token on GitHub with read access to the repositories you want analyzed. See Managing your personal access tokens.
2. In the Connect your code step, select GitHub, then use a Personal Access Token instead.
3. Enter the token in Personal Access Token.
4. Optionally, enter a Label to recognize the connection later.
5. Select Connect.

The connection appears under GitHub connections as Personal Access Token.

Pick a repository and branch

With a connection selected:

1. In Repository, select a repository from the list. To type it instead, select Enter owner/repo manually and enter it as owner/repository.
2. In Branch, select a branch. Faustine preselects the repository's default branch. An empty branch also means the default branch.
3. For a monorepo, set the folder Faustine analyzes. The field is Frontend path for a Web Agent and API path for an API. Leave it empty for the repository root.

Automatic updates

With the GitHub App, Faustine receives your pushes through the app, so keeping the agent up to date needs nothing else on GitHub.

Disconnect

To delete a connection, open the Connect your code step of a new Web Agent or a new API, select the provider, and select the delete button on the connection's row. A connection that a Web Agent or an API uses cannot be deleted until you connect them to another source.

Deleting a connection made with the GitHub App leaves the app installed on your GitHub account. To end the app's access as well, uninstall the Faustine GitHub App on GitHub. Faustine marks a connection as revoked when its app is uninstalled, and analyses of its repositories fail until you connect again.

Troubleshooting

Next steps

• Connect your code: the rest of the step for a Web Agent.
• Create an API: connect the repository of an API.
• Upload a ZIP instead of a repository: analyze code without a connection.