CircleCI の config.yml のチェックはローカルで行おう
CircleCI の config.yml を修正する時など、ファイルのバリデーションなども行わずに Push してたことにより、構文に間違いがあった時など無駄な時間を費やしていたので、今回はそんな反省を活かしてローカルで config.yml のバリデーションを行う方法を紹介します。
CircleCI CLI のインストール
CircleCI CLI はその名の通り、CircleCI の便利なツールを CLI(コマンドラインインターフェース)から利用できるもので、下記のようなことをすることができます。
まずは、Homebrew で CLI をインストールします。
$ brew install circleci
Homebrew がない場合でも、curl などからインストールすることも可能です。詳しくはドキュメントのクイックインストール を参照してください。
config.yml のチェック
.circleci/config.yml があるプロジェクトのルートに移動します。
$ cd Hoge
移動したら、下記コマンドで config.yml のバリデーションを実行してみます。
$ circleci config validate
Error: Unable to parse YAML
while constructing a mapping
in 'string', line 1, column 1:
version: 2.1
^
found duplicate key executors
in 'string', line 11, column 1:
executors:
^
上記のように間違った構文をローカルで検出することができるようになりました🎉
