Skip to main content
For what differs between this platform and the others, see Platform Support.
GitHub repositories are connected to Gitar by installing the Gitar GitHub App. The app handles authentication, permissions, and webhook delivery, so there are no tokens or secrets to manage.

​
Prerequisites

  • A Gitar account, signed in before you start the installation
  • Permission to install a GitHub App on the GitHub organization you want to connect

​
Setup Instructions

Log into Gitar before you start the installation, and start it from Settings -> Configuration in Gitar or from the Connect your repositories onboarding step. Installing the app from GitHub Marketplace or a direct app link while signed out leaves the app installed on GitHub with nothing connected in Gitar.
1

Access Gitar Dashboard

In Gitar, go to Settings -> Configuration, or use the Connect your repositories onboarding step if you are still onboarding. Click Connect for GitHub to begin the installation process.
2

Install the GitHub App

You will be redirected to GitHub to install the Gitar App. Select the GitHub organization where you want to install the app.
3

Select Repositories

Choose which repositories Gitar should have access to. You can grant access to all repositories in the organization or select specific ones.
You can modify which repositories the Gitar app can access at any time. Go to your GitHub organization Settings -> Installed GitHub Apps -> Gitar -> Configure to update repository access.
4

Confirm Installation

Review and approve the installation on GitHub. Once confirmed, you will be redirected back to Gitar with the connection active.

​
Permissions

The installation asks you to grant two sets of permissions. Both are required. 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:
  • Analyze your codebase and determine the changes it needs to make
  • Create and manage pull requests and issues related to code maintenance tasks
  • Push code changes to branches
Gitar does not store your code. Code is checked out, processed, and discarded. 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:
  • Introspect GitHub Actions logs and diagnose build failures
  • Read PR comments and review feedback
  • Fix build errors and address code review feedback automatically
  • Improve the quality of its PRs by responding to CI results

​
Supported GitHub Deployments

Gitar supports repositories hosted on github.com. GitHub Enterprise Server is not supported. For a self-hosted code host, Gitar supports GitLab Self-Managed, Azure DevOps Server, and Bitbucket Data Center.

​
Troubleshooting

This happens when the installation is started from GitHub while signed out of Gitar. GitHub shows the Gitar app installed, but Gitar has no record of it, so pull requests in those repositories are ignored.To recover, uninstall the app from your GitHub organization under Settings -> Installed GitHub Apps -> Gitar -> Uninstall. Then log into Gitar and start the installation again from Settings -> Configuration, or from the Connect your repositories onboarding step if you have not finished onboarding.
An installation binds to the Gitar organization active in your session when GitHub redirects you back, not to the GitHub organization you installed it on. If you belong to more than one Gitar organization, switch to the right one before starting the install.To move an existing installation, uninstall it on GitHub, switch to the correct organization in Gitar, then install again from Settings -> Configuration.
Verify that the GitHub App is installed on the correct organization and has access to the repository in question. In your GitHub organization, go to Settings -> Installed GitHub Apps and confirm the Gitar app is listed and configured for the expected repositories.
Confirm the GitHub App has write access to the repository. If you are using branch protection rules, you may need to add the Gitar app to the bypass list so it can push commits and update protected branches.
Go to your GitHub organization Settings -> Installed GitHub Apps -> Gitar -> Configure to modify repository access. Changes take effect immediately.