Skip to main content

GitHub / GitLab / BitbucketアカウントをBitriseに接続する

概要

自動Webhook登録など、Bitriseが提供するすべての機能を最大限に活用するには、GitHub / GitLab/BitbucketアカウントをBitriseアカウントに接続する必要があります。

Bitrise needs access to your code in a Git repository to be able to build. We recommend connecting your Git provider account to Bitrise for this and we offer two main methods of doing so:

  • The Bitrise GitHub App: We strongly recommend using the GitHub App to connect your Bitrise account to GitHub. The app offers increased security and granular repository access. Using the app means you don't need SSH keys or webhooks. This works on the Workspace level: you connect a Workspace to a single GitHub account or organization.

  • OAuth application to the Git provider that allows access to all repositories on the account. This means connecting your personal Bitrise account to a Git provider account. This method is supported for GitHub, GitLab, and Bitbucket.

次の 2 つの方法のいずれかで、3 つの Git プロバイダー アカウントすべてを Bitrise アカウントに接続できます。

  • 新規追加時のアカウント連携 アプリ.

  • からアカウントを接続する プロファイル設定 ページ。

Gitプロバイダーごとに1つのアカウント

同じGitプロバイダーの2つのアカウント(たとえば、2つのGitHubアカウント)をBitriseに接続することはできないことに注意してください。

1 つの Git プロバイダー アカウントの接続は最終的なものではありません。いつでもアカウントを切断して別のアカウントに接続できます。 間違った Git アカウントを Bitrise にリンクしました.

GitHub App integration

概要

The Bitrise GitHub App allows users to connect their Bitrise Workspace to a GitHub account or organization with a GitHub App that provides granular access with increased security and automatic status updates.

The best way to connect your Bitrise account to your GitHub repositories is by integrating with a GitHub app. The Bitrise GitHub app has a number of features that make integration easier:

  • The app eliminates the need for an SSH key, a Personal Access Token, and a service credential user. For access, it generates a temporary access token before every build, significantly increasing security.

  • It provides granular access to your repositories: no need to grant access to an entire GitHub organization, instead select the specific repositories the app can access.

  • With the app installed, you automatically receive Bitrise status updates directly on GitHub with the GitHub Checks app. No need for configuring status reports separately.

The Bitrise GitHub app is supported for all GitHub Cloud users. GitHub Enterprise Server users need to create and install a different GitHub app, as described in the relevant guide.

Connecting via the GitHub App integration

This guide is intended for GitHub Cloud users, including GitHub Enterprise Cloud users, who wish to install the Bitrise GitHub App and connect their Bitrise Workspace to a GitHub account or organization with the app. For GitHub Enterprise Server users, we have a separate guide: Integrating self-hosted GitHub Enterprise Server with Bitrise

You can connect via the GitHub App integration in two ways:

  • From the Workspace settings page.

  • When adding a new Bitrise app.

One GitHub App installation per Workspace

A Workspace is always associated with a single installation of the Bitrise GitHub App. No Workspace can be connected to multiple installations of the Bitrise GitHub App.

Connecting a GitHub App from the Workspace settings page

A Bitrise GitHub App installation is tied to a Workspace. You can always install and check its connection from the Workspace settings page.

  1. On the Bitrise main page, select your Workspace from the dropdown menu.

  2. From the navigation menu on the left, select Settings.

  3. On the Workspace settings page, select Integrations.

  4. Select the Git provider tab.

  5. Under GitHub, you can see the GitHub App card with Connect via the Bitrise GitHub App. Click Connect.

    github-app-card.png
  6. If you haven't authorized the Bitrise GitHub App before, you will be prompted for authorization at this point:

    authorize-checks.png
  7. You will be prompted to select the GitHub account or organization you want to connect. If you don't find the one you need in the list, you need to install the App to that account or organization first: click the link below the list of accounts.

    install-the-app.png
  8. Once you click the link, you will be prompted to select an account or organization. After selecting one, you will be transferred to the Install & Authorize page.

  9. On the Install & Authorize page, select the access type:

    • All repositories: the Bitrise GitHub App will have access to all repositories belonging to the account or organization, including future ones.

    • Only select repositories: Select one or more repositories that Bitrise will be able to access. You can add more later but to do so, you will need to reconfigure your repository access on the app's page.

    authorizing-app.png
  10. When done, click Install & Authorize. You will be redirected to the Workspace settings page.

    Authorization

    If you are not authorized on GitHub to install the app, you can still request the installation. Once a GitHub Admin approves the installation, you can come back and select the App installation from the list.

  11. If you have existing apps with OAuth connection, we recommend switching them over to the GitHub App connection.

Connecting a GitHub App when adding a new app

During the process of adding a new app on Bitrise, you have to select how Bitrise can access your repository. This process allows connecting the app via the GitHub App.

  1. Start the process of adding a new app.

  2. At the Select a repository section, select GitHub App (recommended) from the Provider dropdown menu.

    select-repository.png
  3. Click Connect account.

    connect-github-app.png
  4. You will be prompted to select the GitHub account or organization you want to connect. If you don't find the one you need in the list, you need to install the App to that account or organization first: click the link below the list of accounts.

    install-the-app.png
  5. Once you click the link, you will be prompted to select an account or organization. After selecting one, you will be transferred to the Install & Authorize page.

  6. On the Install & Authorize page, select the access type:

    • All repositories: the Bitrise GitHub App will have access to all repositories belonging to the account or organization, including future ones.

    • Only select repositories: Select one or more repositories that Bitrise will be able to access. You can add more later but to do so, you will need to reconfigure your repository access on the app's page.

    authorizing-app.png
  7. When done, click Install & Authorize. You will be redirected to continue adding your new Bitrise app.

アプリを追加するときにGitプロバイダーアカウントを接続する

Connecting a Git provider account with an OAuth app allows Bitrise to:

  1. あなたにログインします bitrise.io アカウント。

  2. クリック + 上部のメニュー バーの記号をクリックして選択します。 Web UI に新しいアプリを追加.

    CLI からの新しいアプリの追加

    CLI を使用して新しいアプリを追加することもできます。詳細については、こちらをご覧ください CLIからの新しいアプリの追加.

  3. 新しいアプリを作成する ページで、アカウントを選択し、アプリのプライバシー設定を設定します。

  4. の下にあるラジオ ボタンを使用します。 リポジトリを選択 セクションで、リモート リポジトリを選択するか、手動で URL を入力するかを選択します。

    git URL を手動で入力することを選択した場合は、 Git リポジトリ (クローン) URL フィールドをクリックして .

  5. リモート リポジトリを選択した場合は、アプリのリポジトリの Git サービス プロバイダーを選択します。そのプロバイダーのアカウントが Bitrise アカウントに接続されていない場合、UI に接続オプションが表示されます。

    select_git_repo.png
  6. クリック アカウントを接続.これにより、Git プロバイダーのログイン ページが表示されます。

  7. Gitプロバイダーアカウントにログインします。

  8. bitrise.ioを承認するように求められるはずです-やってください!成功した場合は、Bitriseにリダイレクトされ、アカウントが正常にリンクされたことを通知するポップアップメッセージが表示されます。クリック わかった

プロファイル設定ページからGitプロバイダーアカウントを接続する

Connecting a Git provider account with an OAuth application allows Bitrise to:

  1. 右上隅にあるアカウントセレクタのドロップダウンメニューを開きます。

  2. を選択 アカウント設定 オプション。

    account-settings.png
  3. 左側のメニューバーで、接続するGitプロバイダーの名前の横にあるトグルをクリックします。

    Connect account to Bitrise
  4. Gitプロバイダーアカウントにログインします。

  5. bitrise.ioを承認するように求められるはずです-やってください!成功した場合は、Bitriseにリダイレクトされ、アカウントが正常にリンクされたことを通知するポップアップメッセージが表示されます。クリック わかった

Gitプロバイダーアカウントの切断

  1. 右上隅にあるアカウントセレクタのドロップダウンメニューを開きます。

  2. を選択 アカウント設定 オプション。

    account-settings.png
  3. 左側のメニューバーで、切断するGitプロバイダーの名前の横にあるトグルをクリックします。

Switching from OAuth connection to the GitHub App

If your Bitrise app 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.

Can't switch back

Once you switch an app from the OAuth connection to the GitHub App, you won't be able to switch back!

To switch:

  1. Install the Bitrise GitHub App as described in the relevant guide: Connecting a GitHub App from the Workspace settings page.

  2. Bitriseでアプリを開くには、 管理者 アプリチームでの役割

  3. に移動します 設定 タブ。

    app-settings.png
  4. On the left navigation menu, select Integrations and go to the Git provider tab.

  5. In the Git integration status section, you can see a blue card with information about GitHub App support. To switch, click Switch to GitHub App.

    switch-to-github-app.png