書評：CircleCI実践入門

はじめに

先日発売されました「CircleCI実践入門」を読みました。2020年9月現在、唯一日本語で書かれたCirecle CI本ということで期待して購入したところ、取り扱われている情報の質・量ともに大変満足のいく本でした。そこで、今回本書籍について簡単に書評を書こうと思った次第です。

この記事で取り扱う内容

• 本書籍をオススメする人について（同時に、この本のユースケース）
• 読むうえで必要な前提知識
• 各章のポイント、特にCircleCIを理解・実践する上で意識した方がよいと思ったこと
• オススメの読み方

この記事では取り扱わない内容

• 具体的なconfig.ymlの記述や各種設定の仕方について(書籍には書かれています)

誰向けの本か

• CI/CD周りの知識が欲しい

• CIrcleCIをまだ使っていないが使ってみたい

• CircleCIを使うかはわからないが、とりあえず機能を知ったうえで検討したい

• CircleCIを使っているが、使い方がわからない

• CircleCIを使いこなせているが、もっと良い使い方があるなら知りたい

• CircleCIの必要知識が体系的にまとまった本が欲しい

上記に一つでも当てはまるなら購入を検討されてはいかがでしょう

前提知識

（ほぼ）必須

• git / GitHub に関する知識
• シェルスクリプト
• 手作業でビルド、テスト、デプロイする方法

推奨（なくても読むことは可能だがあると読みやすい）

• Dockerに関する知識
• CI/CDを導入したいアプリのビルド、テストする方法
• AWSに関する知識
• YAML（書籍中で簡単な説明あり）
• CI/CD に関する知識

各章ポイントメモ

※業務上当面必要にならないため、第8章の一部、および第9章～第11章は読み飛ばしてます

第１章 なぜCI/CDが必要なのか

• ビジネスに変化への対応が求められる⇒アジャイル開発が重要視

• アジャイル開発においては、システムを安定稼働させつつ早く開発することが求められる⇒DevOpsの思想に行き着く

• ビルド、テスト、デプロイ作業を手作業（ミスが起きる、遅い）ではなく自動化（一度うまくいけば（機能が壊れない限り）そのまま、早い）⇒CI（継続的インテグレーション）/CD（継続的デリバリ、あるいはデプロイ）

第２章 CircleCIの基本

• 一つのリボジトリをひとつのプロジェクトとみなす
• プロジェクトごとのビルド実行内容は.circleci/config.ymlですべて管理する
• 制御構文：ステップ（実行コマンド※後述のOrbで用いるCommandとは別）、ジョブ（ステップのまとまり）、ワークフロー（ジョブの実行順序を制御）
• 実行環境：ジョブごとに実行環境（Executor）が違う。選択可能な実行環境：Docker、Macine(Linux)、macOS、Windows
• ジョブごとに実行環境が異なる⇒ジョブの生成物を永続化する必要がある：ワークスペース・キャッシュ・（アーティファクト）を使い分ける
• Orbs：パッケージ化された処理をまとめたもの。(Orbs名)/(Job/Command名)で使用。OrbsRegistryで管理

第３章 環境構築

• リボジトリの管理者がCircleCIでのプロジェクトの管理者となる。
• CircleCIはローカル環境でも（機能制限付きで）使用可能。文法チェックやデバッグに使えるが、ワークフローは使えないので、ジョブ単体ずつデバッグする
• SSHデバッグは原因が一目でわからないエラーのデバッグに有用だが、SSHデバッグを実行した場合、SSH接続を切っても課金は終わらない。かならずジョブを終わらせる

第４章 ワークフローでジョブを組み合わせる

• シーケンシャル（順次）かファンイン／ファンアウト（並列）か
• ひとつのジョブに大きい複数の責務を負担させないよう、ジョブを小さく分割する
• ジョブの依存関係はrequiresキーで管理

第５章 実践的な活用法

• プルリクが来た場合、ビルドが正常である場合のみマージするよう設定可能
• 環境変数の使い分け
• メールやスラックと提携させて通知させる
• GitHubのプルリクに対しコメントを送る
• SSHキー（ユーザーキー、デプロイキー）の使い分けは、ベストプラクティスに従う

第６章 テストの基本と最適化

• 基本的にローカルで構築・実行したテストをCIで実行する
• DBを使ったテストやブラウザを使ったE2Eテストも実行可能
• テストを分割、並列に実行する、キャッシュを利用する、CI用のDockerイメージを用意するなど、実行時間を減らす工夫をする
• テストサマリを用いてテスト結果レポートを出力する

第７章 継続的デプロイの実践

• Test in Production ：本番環境でテストをする（テスト環境でのテストには限界がある）
• 仮に本番環境で問題が見つかったのならすぐにロールバックする（前バージョンに戻す）
• ロールバックとリリースを迅速に行うためにCD（継続的デプロイ）が必要となる
• CDを行うには、Orbsを用いると効率的（サンプルではAWSのECRとECSのOrbsを使用）
• リリース時にバグが見つかった：バグフィックス版を再度プッシュするか、取り消しのコミットをプッシュする（ロールバック）

第８章 Webアプリケーション開発、インフラでの活用

• Webアプリケーション開発：TypeScript、Rails、Laravel、Spring Bootに関するビルド、テストについてサンプルで解説
• インフラでの活用：Dockerのビルド設定とCircleCIを用いたTerraformの自動実行についてサンプルで解説

第１２章 Orbsの作成

• 開発用Orbsと本番用（安定版）Orbsがある
• 一度公開した本番用Orbsは基本的に削除できない（セキュリティに注意）
• Orbs設計の際は要件（リンク先）を満たすようにする
• usageを用意する（Orbsの使い方を例示する）
• Orbsの開発にもCI/CDを導入する

オススメの読み方

ある程度CircleCIについて知っている方であれば、知りたいところを読むリファレンス的な使い方で問題ないです。（体系的に情報がまとまっている上に、巻末にconfig.ymlの構文がまとめられていますので、おおよそ知りたいことは調べられる作りだと思います）

CircleCI初学者の方であれば、上記の前提知識を学習してから第2～5章までを読み、CircleCIの基本的な使い方を学んだ後、CircleCIをアプリケーションに導入していくうえで必要な知識を適時以降の章から学んでいく、という読み方にするとよいと思います。