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

アプリの構成YAMLの保存

YAML ファイルのサイズ制限

bitrise.ymlとbitrise.secrets.ymlファイルの合計サイズは 400KB を超えることはできません。

プロジェクトの設定YAMLファイルを保存する方法は2つあります。

  • ファイルをGitリポジトリに保管する: この方法では、ファイルの管理とバージョン管理を完全にコントロールできます。
  • bitrise.ioに保管する: Bitriseが設定を保存し、いつでもWebサイトからアクセスできます。この方法では、設定ファイルはリポジトリから完全に独立します。

この2つの方法はいつでも切り替えられます。

参照

設定YAML構文の完全なリファレンスについては、設定YAMLリファレンスを参照してください。

リポジトリにbitrise.ymlファイルを保存するClick to copy link​

設定YAMLファイルをリポジトリに保存すると、Bitriseのビルドプロセスはそのファイルを使ってビルドを実行します。つまり次のとおりです。

  • You have設定ファイルのバージョン管理を完全にコントロールできます。
  • Workflows/Pipelinesやトリガーを変更するたびに、その変更をリポジトリ内のファイルにコミットする必要があります。Workflow Editorを使えば直接コミットできますし、手動でファイルをコミットすることもできます。

事前に独自の設定YAMLファイルを作成する必要はありません: bitrise.ioに保存されているファイルを使用できます。

この機能を使用するには、サービス認証情報連携、またはGitHubアプリ連携が必要です。どちらも利用できないプライベートホスト型リポジトリでYAファイルをホストする場合は、回避策が必要です。

注記

設定ファイルをリポジトリに保存するには、初回は手動でコミットする必要があります。それ以降の変更については、GitHubまたはGitLabを使用している場合、Workflow Editorを使ってファイルを直接リポジトリにコミットできます。Bitbucket Cloudを使用している場合は、毎回手動でファイルをコミットする必要があります。

  1. Bitriseでプロジェクトを開き、Project settingsページに移動します。

  2. Collaborationを選択します。

  3. Service credential userセクションを確認します。service credential userは、リポジトリに少なくともreadアクセス権を持つBitriseユーザーである必要があります。

    GitHubアプリ連携

    GitHubアプリ連携を使用している場合、設定YAMLファイルをリポジトリに保存するためにservice credential userは必要ありません。

  4. Workflow Editorを開きます。

  5. ヘッダーのStored on Bitrise(またはbranch name)の横にあるシェブロンをクリックし、Change storage...を選択します。

    Workflow Editorのストレージ変更ダイアログ

  6. プロジェクトのリポジトリにbitrise.ymlを追加するよう求められたら、2つの選択肢があります。

    • 現在のbitrise.ymlファイルの内容をクリップボードにコピーする。その後、自分でファイルを作成し、内容をコピーして貼り付けます。
    • 現在のbitrise.ymlファイルをダウンロードする。
  7. リポジトリでbitrise.ymlファイルをコミットします。

    次のいずれかを行います。

    • リポジトリのルートにファイルをコミットする。
    • 別の場所にファイルをコミットする。この場合、Bitriseでパスを指定する必要があります。
    Default branch

    アプリのdefault branchには常にbitrise.ymlファイルが必要です。他のブランチには異なるbitrise.ymlファイルを保存でき、Workflow Editorでそれらを読み込むことができます: リポジトリの複数のブランチにbitrise.ymlファイルを保存する。

    bitrise.ioでSettingsタブに移動し、DEFAULT BRANCHオプションを確認することで、Bitriseプロジェクトのdefault branchを確認できます。

  8. Bitriseに戻り、Bitrise.yml locationフィールドに設定ファイルへのパスを設定します。

    • 設定ファイルをリポジトリのルートに保存している場合は、フィールドを空のままにします。
    • リポジトリの別の場所にファイルを保存している場合は、パスを指定します。
  9. Validate and saveをクリックします。

    検証

    リポジトリ内のbitrise.ymlファイルは、常に有効な状態にしておく必要があります。構文が正しくないと、ビルドが失敗する可能性があります。

問題がなければ、bitrise.ymlのストレージ設定が正常に変更されたことを示す確認メッセージが表示されます。

Bitrise websiteのIPアドレスを許可リストに追加する

コードの保存に何らかの自己ホスト型ソリューションを使用している場合、Bitrise websiteとそのバックグラウンドワーカーの静的IPアドレスを許可リストに追加する必要がある場合があります。これにより、bitrise.ymlファイルを自分のリポジトリに保存したり、Bitriseからビルドステータスの更新を受け取ったりといった機能を利用できます: Bitrise websiteのIPアドレス。

プライベートホスト型リポジトリClick to copy link​

残念ながら、この機能はservice credential user連携やGitHubアプリ連携を利用できないユーザーにはまだ対応していません。たとえば、リポジトリがプライベートなIPサブネット内からしかアクセスできない場合などです。ただし、回避策はあります: プライベートホスト型リポジトリでbitrise.ymlを保存する。

GitHub Enterpriseの場合、bitrise.ymlファイルをGitHub Enterpriseリポジトリに保存できる連携機能を提供しています: GitHub EnterpriseとBitriseの連携。

設定YAMLのカスタムパスを設定するClick to copy link​

デフォルトでは、ビルドの実行時にBitriseはリポジトリのルートにある設定YAMLを探しますが、ファイルをリポジトリ内の別の場所に保存することもできます。

その方法は次のとおりです。

  1. 設定YAMLファイルをリポジトリにコミットします。

  2. Bitrise にアクセスして Log in、左側の Bitrise CI を選択し、プロジェクトを選択します。

  3. メインページの Workflows ボタンをクリックします。

  4. ヘッダーのStored on Bitrise(またはbranch name)の横にあるシェブロンをクリックし、Change storage...を選択します。

  5. Bitrise.yml locationフィールドに、ファイルをコミットした場所のパスを設定します。

    config-yaml-source.png

リポジトリに保存されたbitrise.ymlを更新するClick to copy link​

bitrise.ymlがリポジトリに保存されている場合、Workflow Editorから直接変更をプッシュできます。コピー&ペーストや手動でのコミットは不要です。

  1. Bitrise にアクセスして Log in、左側の Bitrise CI を選択し、プロジェクトを選択します。

  2. メインページの Workflows ボタンをクリックします。

  3. デフォルト以外のブランチを編集する場合は、ヘッダーのbranch nameの横にあるシェブロンをクリックし、Switch branch...を選択します。

    Workflow EditorのConfiguration optionsメニュー(ブランチの切り替え、YAMLファイルのダウンロード、ストレージ変更オプションを表示)

  4. Workflow Editorで変更を行います。

  5. 右上にあるSave changesをクリックします。

  6. 保存方法を選択します。

    • Current branch: 読み込み元のブランチに直接コミットしてプッシュします。
    • New branch: 任意の新しいブランチにプッシュします。コードレビューに便利です。
    • Manual update: YAMLをダウンロードまたはコピーし、自分でコミットします。
    注記

    Workflow Editorから直接プッシュできるのは、GitHubまたはGitLabを使用している場合のみです。Bitbucket Cloudを使用している場合は、毎回手動でファイルをコミットする必要があります。

    リポジトリにマージ前にプルリクエストを必須とするブランチ保護ルールが設定されている場合、Current branchは一般的なFailed to push changes. Please try again.エラーで失敗することがあります。このような場合は、ブランチ保護が原因である可能性が高いため、代わりにNew branchを使用してください。これは変更を新しいブランチにコミットし、そこからプルリクエストを開くためのリンクを提供します。

  7. コミットメッセージを入力し、Push changesをクリックします。

リポジトリの複数のブランチにbitrise.ymlファイルを保存するClick to copy link​

bitrise.ymlを初めてリポジトリに追加する際は、default branchにコミットする必要があります。bitrise.ymlファイルをリポジトリに保存する場合、default branchには常にbitrise.ymlが必要です。

ただし、リポジトリからbitrise.ymlを使用するための初期設定を一度行えば、他のブランチにbitrise.ymlファイルを保存し、そのいずれかを使ってビルドを実行できます。Bitriseでリポジトリのあるブランチをビルドしたい場合は、そのブランチにbitrise.ymlファイルが必要です。また、default branchには常にbitrise.ymlファイルを置いておく必要がある点を忘れないでください。

Workflow Editorでブランチを読み込む

Workflow Editorでは、任意のブランチから直接bitrise.ymlを読み込めます。変更を行う前にエディタの上部でブランチを選択し、完了したらそのブランチに保存し直します。

複数のブランチにbitrise.ymlファイルを配置したBitriseのセットアップ

FantasticAppというアプリがあるとします。FantasticAppのGitリポジトリでは、default branchはmainという名前です。また、deployブランチもあります。

mainへのコードプッシュまたはプルリクエストは、main-workflowというWorkflowをトリガーします。deployへのコードプッシュまたはプルリクエストは、deploy-workflowというWorkflowをトリガーします。

リポジトリ内には、mainブランチとdeployブランチの両方にbitrise.ymlファイルがあり、両方のWorkflowsが含まれています。Workflowsを変更する際、FantasticAppチームは両方のブランチでWorkflowsが最新の状態になるよう、変更したbitrise.ymlファイルを両方のブランチにコミットします。

bitrise.ymlファイルをbitrise.ioに戻すClick to copy link​

デフォルトの設定では、bitrise.ymlファイルはbitrise.ioに保存されます: 新しいアプリを追加すると、bitrise.ymlファイルが自動的に作成され、Bitriseのウェブサイトに保存されます。この設定で問題なければ、何も変更する必要はありません。

ただし、設定ファイルをリポジトリに保存するようにストレージ設定を変更した場合でも、いつでも簡単にbitrise.ioへの保存に戻すことができます。

  1. Bitrise にアクセスして Log in、左側の Bitrise CI を選択し、プロジェクトを選択します。

  2. メインページの Workflows ボタンをクリックします。

  3. ヘッダーのbranch nameの横にあるシェブロンをクリックし、Change storage...を選択します。

    git-repo-source.png

  4. これ以降bitrise.ioで使用するbitrise.ymlファイルを選択します。

    アプリのリポジトリに保存されているbitrise.ymlファイルの内容をコピーできます。

    bitrise.ioで使用していたbitrise.ymlファイルの最新バージョンをコピーできます。

    yaml-source-switchback-dialog.png

  5. Validate and saveをクリックします。

問題がなければ、bitrise.ymlのストレージ設定が正常に変更されたことを示す確認メッセージが表示されます。