Connecting GitHub

GitHub repos can be connected by installing the Gitar Bot app, available in the GitHub Marketplace. This app is installed on your GitHub organizations by a Gitar admin user who has GitHub admin permissions. Make sure you are logged into to your GitHub account when you install the app.

Important notes: If the initial Gitar administrator does not have GitHub admin permission for your GitHub Organization, they should invite a new Gitar admin user who has GitHub admin permissions to complete the repo connection setup. This Gitar Bot app can be installed only on GitHub organizations and not on individual GitHub accounts.

GitHub App Permissions

When installing the Gitar Bot, you'll be asked to grant certain permissions to the bot. These permissions are essential for Gitar to function properly.

Read and Write Access to Code, Issues, and Pull Requests

Gitar needs read and write access to your repository's code, issues, and pull requests. This enables Gitar to create and manage pull requests and issues related to code maintenance tasks.

With read access to code, Gitar can analyze your codebase and determine the changes it needs to make. Write access allows Gitar to make its code changes. Importantly, Gitar does not save or store any of your code on our servers - we simply check it out, process it, and discard it.

Read and Write Access to Actions, Checks, Commit Statuses, and Workflows

Gitar requires both read and write access to actions, checks, commit statuses, and workflows to monitor and manage your repository's build process. This allows Gitar to improve the quality of its PRs by fixing build errors and responding to your review feedback.

Read access allows Gitar to introspect GitHub Action logs and diagnose build errors. It also allows it to read PR comments. Write access enables Gitar to fix build errors and address code review feedback automatically.