公式ドキュメントはこちら
ルートエントリ
- version は必須
- jobs は必須
- jobs.build は必須
version: 2
jobs:
build:
....
Jobs
Jobsは Circle CI 内で利用するジョブ定義で、buildはデフォルトで用意され自動で実行される必須のジョブ。
buildを始めとする各ジョブでは以下の項目を定義する。
-
docker|machine実行環境の指定でどちらかが必須 -
steps実行されるコマンドのリスト。必須。 -
working_directorystepsを実行するディレクトリ。必須。 -
parallelism並行稼動させるインスタンスの数。 Optionalでデフォルト1 -
environment環境変数のマップ。Optional。 -
branches反応するブランチを定義するマップ。Optional
Docker
別途記述予定
Machine
必要なキーは enabled のみで、直接 true をアサインすることも可能
branch
only と ignore を指定できる。
特定のブランチに限定したり
branches:
only:
- master
- /rc-.*/
除外するブランチのみを指定したり出来る。
branches:
ignore:
- develop
- /feature-.*/
Steps
環境上で実行するコマンドを指定できる。
Steps には配列を記述し、内部には run.name run.command からなるマップを配置する。
steps:
- run:
name: Running tests
command: make test
Yaml の | を使用して、複数行コマンドに一つの名前をつけることも可能
steps:
- run:
name: Initialize Database
command: |
php artisan migrate:refresh
php artisan db:seed
単純に単一コマンドだけの場合、以下のような省略コマンドも許容される。
steps:
- run: make test
中には 組み込み Step というものもあり、特定のキーワードを文字列やキーにて直接指定する事もできる。
steps:
- run: apt-get update && apt-get -y install git unzip zlib1g-dev
- checkout
- run: docker-php-ext-install pdo pdo_pgsql zip
上記での checkout が組み込みStepに該当する。組み込みStepには以下のようなものがある。