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

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:

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

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

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

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

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

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

このライブラリはプライベートなステップライブラリにすることができます。GitHubアプリ経由でこのようなライブラリにアクセスするには、 authenticate-host-with-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:

注意： authenticate-host-with-netrc Step には完全なソース識別子があり、プライベート ライブラリではなく公式の Bitrise Step ライブラリから取得されていることを保証します。

Using the Step requires specifying three inputs: the host, the Git username, and the Git password. The Bitrise GitHub App integration uses token-based authentication: each build receives a one time token under the GIT_HTTP_PASSWORD Environment Variable. This Env Var can be used as the password. The username can't be empty because the Step will fail but it is not used so it doesn't matter what you put there.

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: {}

If you attempt to run git clone or other git commands for a linked repository, your build might fail with an authentication error. This is because the authentication credentials are stored in a local netrc file. This file is automatically generated by the official Git Clone Step.

However, if you use your own script to perform git clone, or you use any other Git command requiring authentication before the Git Clone Step, you need to create the netrc file. You have two ways:

Using the Step requires specifying three inputs: the host, the Git username, and the Git password. The Bitrise GitHub App integration uses token-based authentication: each build receives a one time token under the GIT_HTTP_PASSWORD Environment Variable. This Env Var can be used as the password. The username can't be empty because the Step will fail but it is not used so it doesn't matter what you put there.

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