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

永続的なビルド環境のクリーンアップ

Bitriseでは、ビルドが開始されるたびに新しい仮想マシンが作成され、ビルド終了時に破棄されます。ただし、弊社のオンプレミスランナーを使用したり、Amazon EC2インスタンスでビルドを実行したりすることで、Bitriseビルドを永続的なビルド環境で実行することも可能です。このような環境では、あるビルドの成果物が後続のビルドに影響を及ぼす場合があります。

self-hosted infrastructureでは、1つのBitriseランナーが複数のビルドを実行します。これにより、ローカルファイルシステム上でビルド間のデータ共有が可能になりますが、あるビルドが別のビルドに影響を与えないよう注意する必要もあります。

この問題を回避するには、Bitrise CLIをエージェントモードで実行するように設定します。エージェントモードでは、ホストマシンの~/.bitrise/ディレクトリにagent-config.ymlを配置する必要があります。このファイルでは、新しいビルドの開始時またはビルドの終了時にクリーンアップするディレクトリを指定できます。また、単純なクリーンアップよりも高度なユースケースがある場合は、独自のカスタムスクリプトを実行することもできます。

セルフホスト環境での Secrets

セルフホスト環境では、Secrets を bitrise.io 上でホストできない場合があります。ビルド設定で引き続き Secrets を使用できるようにするには、次のガイドを参照してください。セルフホスト環境での Secrets。

エージェントモードの設定Click to copy link​

  1. agent-config.ymlファイルを~/.bitrise/ディレクトリに追加します。

  2. クリーンアップ操作を行う正確なフォルダを設定したい場合は、bitrise_dirsプロパティを定義します。

    このプロパティはデフォルト設定を上書きします。たとえば、BITRISE_DEPLOY_DIR環境変数にデフォルトとは異なるパスを設定できます。

  3. bitrise_dirsの下に、ビルドの開始時または終了時に何らかの操作を行いたいディレクトリをKEY: path形式で定義します。

    たとえば、ソースコードのチェックアウト、デプロイ可能なアーティファクト、デプロイ可能なテスト結果アーティファクトのそれぞれに個別のディレクトリを定義できます。

    # Customize the common Bitrise directories
    bitrise_dirs:
    # Root directory for all Bitrise data produced at runtime
    BITRISE_DATA_HOME_DIR: /Users/ec2-user/bitrise

    # Directory for source code checkout.
    BITRISE_SOURCE_DIR: /Users/ec2-user/bitrise/workspace/$BITRISE_APP_SLUG

    # Directory for deployable artifacts.
    BITRISE_DEPLOY_DIR: /Users/ec2-user/bitrise/$BITRISE_APP_SLUG/$BITRISE_BUILD_SLUG/artifacts

    # Directory for deployable test result artifacts.
    BITRISE_TEST_DEPLOY_DIR: /Users/ec2-user/bitrise/$BITRISE_APP_SLUG/$BITRISE_BUILD_SLUG/test_results

    # Directory for the html reports
    BITRISE_HTML_REPORT_DIR: /Users/ec2-user/bitrise/$BITRISE_APP_SLUG/$BITRISE_BUILD_SLUG/html_reports
    同一Workspaceの複数プロジェクト

    同一のWorkspaceの複数のプロジェクトが同じエージェント上で実行される可能性があることを忘れないでください。プロジェクトとそのソースコードのチェックアウトを分離するために、ディレクトリ階層に必ず$BITRISE_APP_SLUGを含めるようにしてください。

    # wrong:
    BITRISE_SOURCE_DIR: /opt/bitrise/workspace
    # correct:
    BITRISE_SOURCE_DIR: /opt/bitrise/workspace/$BITRISE_APP_SLUG
  4. agent-config.ymlファイルにhooksプロパティを追加します。このプロパティは、ビルドの開始時または終了時に実行するアクションを定義します。4つの異なるパラメータがあります。

    • cleanup_on_build_start: 新しいビルドが開始されたときにクリーンアップされるディレクトリを定義します。
    • cleanup_on_build_end: ビルドが終了するたびにクリーンアップされるディレクトリを定義します。ビルドが失敗した場合の実行は保証されません。
    • do_on_build_start: 新しいビルドが開始されたときに実行されるカスタムスクリプトを定義します。
    • do_on_build_end: ビルドが終了したときに実行されるカスタムスクリプトを定義します。ビルドが失敗した場合の実行は保証されません。
    ネストされたWorkflows

    Workflow内のScript Stepは、bitrise local run nested_workflowを実行し、ネストされたワークフローをトリガーできます。このネストされたWorkflowは、親のWorkflowのすべての環境変数とパラメータを継承し、親のWorkflowはネストされたWorkflowの完了を待ちます。この方法でネストされたWorkflowが起動された場合、予期しない動作を避けるため、フックとディレクトリのクリーンアップはこのプロセス内では実行されません。

  5. エージェントモードをテストするには、ビルドを開始します。ログの先頭に次のメッセージが表示されるはずです。

    Running in agent mode
    Config file: .bitrise/agent-config.yml

一般的な設定例Click to copy link​

完全に分離されたビルド

状態を最小限に抑え、信頼性を最大化するために、各ビルドには一意のディレクトリが割り当てられます。ソースコードは各ビルドでゼロからチェックアウトされます。

bitrise_dirs:
BITRISE_DATA_HOME_DIR: /opt/bitrise
BITRISE_SOURCE_DIR: /opt/bitrise/$BITRISE_APP_SLUG/$BITRISE_BUILD_SLUG/workspace
BITRISE_DEPLOY_DIR: /opt/bitrise/$BITRISE_APP_SLUG/$BITRISE_BUILD_SLUG/artifacts
BITRISE_TEST_DEPLOY_DIR: /opt/bitrise/$BITRISE_APP_SLUG/$BITRISE_BUILD_SLUG/test_results
BITRISE_HTML_REPORT_DIR: /opt/bitrise/$BITRISE_APP_SLUG/$BITRISE_BUILD_SLUG/html_reports

hooks:
# Since dirs are unique to each build, there is nothing to clean up here:
cleanup_on_build_start: []

# Clean up everything after the build ends:
cleanup_on_build_end:
- $BITRISE_SOURCE_DIR
- $BITRISE_DEPLOY_DIR
- $BITRISE_TEST_DEPLOY_DIR
- $BITRISE_HTML_REPORT_DIR
ウォームチェックアウト用のShared source codeディレクトリ

より高速なソースコードチェックアウトのために、以前のビルドのソースコードディレクトリを再利用することができます。

bitrise_dirs:
BITRISE_DATA_HOME_DIR: /opt/bitrise
# Use a warm clone of the repo for all builds:
BITRISE_SOURCE_DIR: /opt/bitrise/$BITRISE_APP_SLUG/workspace
# For artifacts and test results, it's still a good idea to place them into unique dirs
BITRISE_DEPLOY_DIR: /opt/bitrise/$BITRISE_APP_SLUG/$BITRISE_BUILD_SLUG/artifacts
BITRISE_TEST_DEPLOY_DIR: /opt/bitrise/$BITRISE_APP_SLUG/$BITRISE_BUILD_SLUG/test_results
BITRISE_HTML_REPORT_DIR: /Users/ec2-user/bitrise/$BITRISE_APP_SLUG/$BITRISE_BUILD_SLUG/html_reports

hooks:
# Since dirs are unique to each build, there is nothing to clean up here:
cleanup_on_build_start: []

# Optional: clean up artifacts and test results.
# Note that $BITRISE_SOURCE_DIR is NOT clean up here!
cleanup_on_build_end:
- $BITRISE_DEPLOY_DIR
- $BITRISE_TEST_DEPLOY_DIR
- $BITRISE_HTML_REPORT_DIR