【AWS】buildspec.ymlとは

buildspec.ymlとは

buildspec.ymlとは、ビルド実行時に実行するコマンドを記述したYAML形式のファイルのこと。
このファイルをソースコードのルートディレクトリに配置することでCodeBuildがbuildspec.ymlを読み込んで実行される。
CodeCommitを使用する場合は、リポジトリのルートディレクトリに配置する。

buildspec.ymlには以下のような項目が記述される。

version

これは必須項目でbuildspecのバージョンを指定する。参考文献では0.2が推奨されていた。

version: 0.2

env

これはオプションの項目で環境変数を設定する。DB接続に関する情報などを設定したりする。

env:
     <環境変数名>:<値>

phases

これは必須項目でビルド実行時にCodeBuildが実行するコマンドを記述する。
また、CodeBuildではフェーズごとに実行する内容を以下のように分けることができる。

■ install
インストールの際にCodeBuildが実行する必要なコマンドを記述する。
■ pre_build
build前にCodeBuildが実行する必要なコマンドを記述する。
■ build
build実行中にCodeBuildが実行する必要なコマンドを記述する。
■ post_build
build後にCodeBuildが実行する必要なコマンドを記述する。

例

phases:
    pre_build:
        commands:
            - <コマンド>

artifacts

ビルドの出力結果に関するデータの保存先情報を記述する。
■ files
これは必須項目でビルド環境でのビルド出力アーティファクトを含む場所を表す。

参考

今回は自分が使った項目だけをまとめたが、他の項目や詳細は以下を参照。
https://docs.aws.amazon.com/ja_jp/codebuild/latest/userguide/build-spec-ref.html