GitHub アプリによるリポジトリへのアクセス

このガイドは、Bitrise GitHub アプリをインストールし、アプリを使用して Bitrise ワークスペースを GitHub アカウントまたは組織に接続したい GitHub Cloud ユーザー (GitHub Enterprise Cloud ユーザーを含む) を対象としています。

GitHub Enterprise Server ユーザー向けには、別のガイドがあります。 セルフホスト型 GitHub Enterprise Server と Bitrise の統合

GitHub App 統合を介して接続するには、次の 2 つの方法があります。

Bitrise GitHub アプリは、アプリ経由でトリガーされるビルドごとに、短期間の一時トークンを生成します。このトークンには、デフォルトで 1 つの権限のみがあります。 content:readつまり、ビルドは GitHub リポジトリにアクセスできますが、それ以外のことは何もできません。

これらの権限を拡張して、ビルド中に他の操作を実行できるようにすることができます。たとえば、これにより、ユーザーはビルドから Git タグをプッシュしたり、カスタム ステータス レポートを作成したり、プル リクエストにラベルを付けたり、新しいバージョン番号をプッシュしたりできるようになります。

拡張できる正確な権限は、GitHub アカウントによって異なります。

権限を拡張するには:

各 Bitrise プロジェクトにはプライマリ Git リポジトリがあります。これはプロジェクトのコードが保存される場所であり、ビルドを開始するとこのリポジトリがクローンされます。デフォルトでは、Bitrise プロジェクトは他のリポジトリにアクセスできません。

ただし、プロジェクトには他のリポジトリが必要になる場合があります。たとえば、ビルド中にアクセスする必要があるプライベート サブモジュールがある場合があります。GitHub App を使用する場合は、追加のリポジトリをリンクすることでこれを実行できます。この機能は、GitHub Cloud と GitHub Enterprise Server の両方で利用できます。

リンクされたリポジトリは、Bitrise プロジェクトが GitHub App インストールを使用してアクセスできるリポジトリですが、プロジェクトのプライマリ リポジトリではありません。

GitHub App インストールを介して接続されたプロジェクトのビルドを実行すると、Bitrise は、デフォルトではプライマリリポジトリにのみアクセスできる一時トークンを生成します。追加のリポジトリがリンクされると、ビルド用に生成されたトークンは追加のリポジトリにアクセスできるようになります。

リポジトリをリンクするには、次の条件をすべて満たす必要があります。

各 Bitrise プロジェクトには、デフォルトのステップ ライブラリ (ステップのリポジトリ) があります。設定でステップの正確なソースが指定されていない場合、Bitrise CLI はデフォルトのライブラリからステップ データを取得します。

このライブラリはプライベートなステップライブラリにすることができます。GitHubアプリ経由でこのようなライブラリにアクセスするには、 netrcでホストを認証する ワークフローで実行される最初のステップとして次のステップを指定します。

format_version: "13"
default_step_lib_source: https://github.com/my-private-org/my-bitrise-steplib.git
project_type: ios
workflows:
  example:
    steps:
    - https://github.com/bitrise-io/bitrise-steplib.git::authenticate-host-with-netrc@0:

注意： netrcでホストを認証するステップは 完全なソース識別子 プライベートライブラリではなく、公式の Bitrise Step ライブラリから取得されるようにするためです。

ステップを使用するには、ホスト、Gitユーザー名、Gitパスワードの3つの入力を指定する必要があります。Bitrise GitHub App統合ではトークンベースの認証を使用します。各ビルドは、 GIT_HTTP_PASSWORD 環境変数。この Env Var はパスワードとして使用できます。ユーザー名は空にできません。ステップは失敗しますが、使用されないため、何を入力しても問題ありません。

format_version: '13'
default_step_lib_source: https://github.com/tothszabi/steplib.git
project_type: ios
workflows:
  example:
    steps:
    - https://github.com/bitrise-io/bitrise-steplib.git::authenticate-host-with-netrc@0:
        inputs:
        - host: github.com
        - username: username
        - password: "$GIT_HTTP_PASSWORD"
    - private-script@1: {}

実行しようとすると git clone または他のgitコマンド リンクされたリポジトリ認証エラーが発生してビルドが失敗する可能性があります。これは認証情報がローカルに保存されているためです。 netrc ファイルです。このファイルは公式の Git クローン ステップ。

ただし、独自のスクリプトを使用して git clone、または認証を必要とするその他のGitコマンドを使用する場合 Git クローン ステップでは、 netrc ファイル。2 つの方法があります。

ステップを使用するには、ホスト、Gitユーザー名、Gitパスワードの3つの入力を指定する必要があります。Bitrise GitHub App統合ではトークンベースの認証を使用します。各ビルドは、 GIT_HTTP_PASSWORD 環境変数。この Env Var はパスワードとして使用できます。ユーザー名は空にできません。ステップは失敗しますが、使用されないため、何を入力しても問題ありません。

workflows:
  example:
    steps:
    - authenticate-host-with-netrc@0:
        inputs:
        - host: github.com
        - username: "username"
        - password: "$GIT_HTTP_PASSWORD"

Bitrise プロジェクトに GitHub アカウントへの OAuth 接続が設定されている場合は、機能を失うことなくいつでも Bitrise GitHub アプリに変更できます。切り替えを強くお勧めします。Bitrise GitHub アプリがインストールされると、Bitrise ビルドを実行するためにサービス認証ユーザー、SSH キー、または Webhook は不要になります。

切り替えるには: