メインコンテンツまでスキップ

GitHub連携

Bitrise GitHub App連携を使って、セッションを本人としてGitHubに対して認証します。新しいセッションではすべて、git clone、git push、およびGitHub CLI(gh)がHTTPS上でそのまま動作するため、個人アクセストークンを貼り付けたりSSHキーを管理したりする必要はありません。

概要Click to copy link​

このインテグレーションを使用するには、Bitrise GitHub Appを組織にインストールし、GitHubアプリを通じてGitHubアカウントをBitriseに接続します。

RDEページでインテグレーションを有効にすると、Bitriseは新しいセッションマシンごとに、有効期間の短いGitHubアクセストークンを配置します。このトークンは、Bitrise(Bitrise GitHub App)上のGitHubアカウント接続を通じて発行されます。

  • トークンの有効期間は最長で8時間です。リストアを含め、セッションが存続する間は自動的に更新されます。
  • 有効期間の長い認証情報がマシンに保存されることはありません。
  • セッションで作成したコミットは、GitHub noreplyメールアドレスを使用して、あなたのGitHubアカウントに紐づけられます。実際のメールアドレスが公開されることはありません。

warm poolから取得したセッションは、取得時のSystemセットアップステップでトークンを受け取ります。On claimフックとそれ以降の処理では、あなたとしてgitとghを利用できます。一方、On createフックは誰もセッションを所有していない時点で実行されたため、利用できません。ライフサイクルフックを参照してください。

GitHubアプリを組織にインストールするClick to copy link​

この連携には、GitHub上で次の 2 つが別々に必要です。

  • Bitrise GitHub App のインストール: アプリにリポジトリへのアクセス権を与えます。GitHub App は、GitHub上でリポジトリを所有するアカウントまたは組織にインストールされている必要があり、そのリポジトリに対してアプリのインストールが有効になっている必要があります。
  • GitHub account 接続: Bitrise GitHub App があなたとして動作することを許可します。これはBitrise Connected accountsページで行います。アプリがすでに組織にインストールされている場合でも必要です。詳細は、連携を有効にするを参照してください。
important

アカウントを接続しても、アプリはインストールされません。Bitrise GitHub App がリポジトリを所有する組織にインストールされていない場合、連携は接続済みと表示されますが、プライベートリポジトリのクローンはすべて失敗します。

WorkspaceがすでにCI用にGitHub App を使用している場合、アプリはインストール済みです。必要なリポジトリに対してインストールが有効になっていることを確認してください。

そうでない場合は、Workspace settingsページからGitHubアプリを接続するの説明に従ってアプリをインストールします。アプリをインストールする権限がGitHubにnot authorized場合でも、インストールをリクエストできます。GitHub Admin がインストールを承認すると、セッションからリポジトリにアクセスできるようになります。

連携を有効にするClick to copy link​

  1. Bitriseを開きます。

  2. Bitriseに Log inし、右上隅のプロフィール画像をクリックしてドロップダウンメニューを開きます。

  3. Account settings オプションを選択します。

    account-settings-page.png

  4. Connected accounts を選択し、Git providers タブを開きます。

  5. GitHub カード(「Connect via the Bitrise GitHub App」と説明されています)で Connect を選択します。GitHub with OAuth カードは使用しないでください。この連携にはGitHub App の接続が必要です。

    Workspaceレベルの接続だけでは不十分です

    この連携は、個人のGitHubアカウント接続を通じてトークンを発行します。組織の管理者がCI用にBitrise GitHub App をすでに接続している場合でも、Connected accounts ページで自分のアカウントを接続する必要があります。セッションがリポジトリにアクセスできるのは、Workspaceのアプリのインストールによるものです。

  6. Bitrise RDE UIで、左側の User settings の下にある Saved Inputs を選択します。

  7. GitHub カードで、アカウントが接続済みと表示されていることを確認し、トグルを有効にします。

    Saved Inputs ページのGitHubカード。接続済みで、有効にできる状態

これ以降に作成した新しいセッションでは、自動的にGitHubアクセスが利用できます。連携を有効にする前に作成したセッションは変更されません。

アクセスできるリポジトリClick to copy link​

セッションはBitrise GitHub App を通じてあなたとして動作するため、次の条件をすべて満たすリポジトリにアクセスできます。

  • GitHub App が、GitHub上でリポジトリを所有するアカウントまたは組織にインストールされている。
  • そのリポジトリに対してアプリのインストールが有効になっている。
  • GitHubユーザーアカウントが、GitHub上でそのリポジトリにアクセスできる。
403 エラーまたは repository not found でクローンに失敗する

ブラウザーで開けるプライベートリポジトリのクローンがremote: Write access to repository not granted、The requested URL returned error: 403、またはrepository not foundで失敗する場合は、Bitrise GitHub App がリポジトリを所有する組織にインストールされていないか、そのリポジトリに対してインストールが有効になっていません。組織のGitHub Admin に、アプリのインストールまたはリポジトリに対する有効化を依頼してください。GitHubアプリを組織にインストールするを参照してください。その後、アカウントを再接続する必要はありません。

アプリがどのリポジトリにインストールされているかを確認するには、次の手順を実行します。

  1. GitHubで、アカウントのinstalled GitHub Appsページを開きます。アプリが組織レベルでインストールされている場合は、組織のページを開きます。
  2. 一覧から Bitrise を見つけ、Configure を選択します。
  3. Repository access で、インストールの対象となっているリポジトリを確認します。

インテグレーションの無効化Click to copy link​

連携を無効にすると、認証情報の発行は即座に停止します。新しいセッションは認証情報を受け取らなくなり、実行中のセッションはすぐにトークンを更新できなくなり、最後に発行されたトークンは8時間以内に失効します。

  1. Bitrise RDE UIで、左側のUser settingsの下にあるSaved Inputsを選択します。
  2. GitHubカードで、トグルをオフにします。