Structure Config YAML
=====================

概要
----

構造リポジトリには、管理対象構造の依存関係とビルドと実行の必要性をGen AI
Builderに通知する構成ファイルが必要です。

構造構成ファイルスキーマ
------------------------

すべての相対パスは、\ ``structure_config.yaml``
ファイルが存在するディレクトリを基にしています。

構成ファイルのスキーマは次のとおりです。

.. code:: yaml

   version: 1.0
   runtime: python3
   runtime_version: 3.11
   build:
     pre_build_install_script: scripts/my-pre-build-install-script.sh
     post_build_install_script: scripts/my-post-build-install-script.sh
     requirements_file: requirements.txt
     cache_build_dependencies:
       enabled: false
       watched_files:
         - requirements.txt
         - scripts/my-pre-build-install-script.sh
         - scripts/my-post-build-install-script.sh
   run:
     main_file: structure.py

構成フィールド
^^^^^^^^^^^^^^

バージョン
^^^^^^^^^^

Structure Configスキーマバージョン番号。

ランタイム
^^^^^^^^^^

ストラクチャに使用するランタイム環境。

runtime_version
^^^^^^^^^^^^^^^

ストラクチャーのランタイム環境の特定のバージョン。

build オプショナル
^^^^^^^^^^^^^^^^^^

ストラクチャーのビルド時構成。

- **pre_build_install_script** -
  pre_build_install_scriptへのパス、依存関係のインストールの前に構造ビルド中に実行します。このパスは、構造構成ファイルへの相対です。または、スラッシュを使用する場合はリポジトリルートからの絶対値
  ``/my-pre-build-install-script.sh`` 。

- **post_build_install_script** -
  post_build_install_scriptへのパス、依存関係のインストール後の構造ビルド中に実行します。このパスは、構造構成ファイルへの相対です。または、スラッシュを使用する場合はリポジトリルートからの絶対値
  ``/my-post-build-install-script.sh`` 。

- **requirements_file** -
  ストラクチャーのrequirements.txtファイルへのパス。

- **cache_build_dependencies** -
  展開を高速化するためにビルドの依存関係をキャッシュするための構成を定義します

  - **enabled** - ビルド依存関係のキャッシュがオンまたはオフ
  - **watched_files** -
    キャッシュをトリガーする特定のファイルを定義無効化、その結果、構造と依存関係の完全な再構築が発生します

run 必須
^^^^^^^^

ストラクチャーの実行時構成。

- **main_file** -
  管理対象構造のエントリーポイントファイルへのパスを指定します。このパスは、
  Structure_config.yamlに対する相対です。または、スラッシュを使用する場合はリポジトリルートからの絶対値
  ``/structure.py`` 。