Repository access with OAuth connection
To take full advantage of all the features Bitrise offers, including automatic webhook registration, you need to connect your GitHub/GitLab/Bitbucket account to your Bitrise account.
Bitrise needs access to your code in a Git repository to be able to build. You can provide access on a project-by-project basis but we recommend connecting your Bitrise account to your Git provider accounts (GitHub, GitLab, and Bitbucket).
One of the ways to connect your accounts is by setting up an OAuth connection. You can connect all three Git provider accounts using OAuth, by either:
-
Connecting the account when adding a new Bitrise project.
-
Connecting the account from your Account settings page.
One account per Git provider
Please note that you cannot connect two accounts from the same Git provider (for example, two GitHub accounts) to Bitrise.
Connecting one Git provider account is not final. You can disconnect an account and connect a different one at any time: Linked the wrong Git account to Bitrise.
Connecting a Git provider with OAuth when adding a project
Connecting a Git provider account with an OAuth app allows Bitrise to:
-
List the available repositories when adding a new project.
-
Automatically register webhooks. Webhooks allow setting up build triggers and enable the use of Git Insights.
-
Log in to your bitrise.io account and select Bitrise CI on the left.
-
Click .
-
Set the project’s privacy setting.
-
In the Select repository section, choose between selecting a remote repository or entering an URL manually.
If you opt to enter a git URL manually, add it in the Git repository (clone) URL field and click .
-
Choose the Git service provider of the app’s repository, if you chose to select a remote repository. If no account with that provider has been connected to your Bitrise account, the UI will display the option to connect.
-
Click . This will take you to the login page of the Git provider.
-
Log in to the Git provider account.
-
You should be prompted to authorize bitrise.io - do it! If successful, you should be redirected to Bitrise, and a pop-up message should inform you that you successfully linked the account. Click .
Connecting a Git provider with OAuth from the Account settings page
Connecting a Git provider account with an OAuth application allows Bitrise to:
-
List the available repositories when adding a new project.
-
Automatically register webhooks. Webhooks allow setting up build triggers and enable the use of Git Insights.
-
Log in to Bitrise, and select Bitrise CI from the left navigation menu.
-
In the upper right corner, click the profile image to open the dropdown menu.
-
Select the option.
-
On the left, under Connected Git providers, click the toggle next to the name of the Git provider you wish to connect.
-
Log in to the Git provider account.
-
You should be prompted to authorize bitrise.io - do it! If successful, you should be redirected to Bitrise, and a pop-up message should inform you that you successfully linked the account. Click .
Disconnecting a Git provider account
-
Log in to Bitrise, and select Bitrise CI from the left navigation menu.
-
In the upper right corner, click the profile image to open the dropdown menu.
-
Select the option.
-
On the left under Connected Git providers, click the toggle next to the name of the Git provider you wish to disconnect.
Switching from OAuth connection to the GitHub App
If your Bitrise project has an OAuth connection set up to your GitHub account, you can change it to the Bitrise GitHub App at any time without losing any functionality. We strongly recommend doing the switch: with the Bitrise GitHub App installed, you no longer need the service credential user, an SSH key, or a webhook to run Bitrise builds.
HTTPS URL required
Please note that the GitHub App requires an HTTPS URL for your repository instead of an SSH one. Normally, you don't have to worry about this: setting up the GitHub App connection changes the URL of your project. If there's an issue, you can change the URL manually: Changing the repository URL.
Can't switch back
Once you switch a Bitrise project from the OAuth connection to the GitHub App, you won't be able to switch back!
To switch:
-
Install the Bitrise GitHub App as described in the relevant guide: Connecting a GitHub App from the Workspace settings page.
-
Open your project on Bitrise with a user that has the Admin role on the project.
-
On the main page of the project, click on the Project settings button.
-
On the left navigation menu, select Integrations and go to the Git provider tab.
-
In the Git integration status section, you can see a blue card with information about GitHub App support. To switch, click .
