【ざっくり解説】CI/CDを導入しよう

ごきげんよう。最近はUnityでの開発に四苦八苦しているgonzoです😿

今回は開発作業を効率化し、質を高める為のCI/CDの例についてざっくり解説していきます。

CI/CDって何？

CI/CDとは、こんな仕組みのことです。

CI（継続的インテグレーション）：
プログラムが正しく動くかを、自動でテストやビルドして確認する仕組み。
CD（継続的デリバリー/デプロイメント）：
テストをクリアしたコードを自動でリリースしたり、本番環境に反映する仕組み。

簡単に言えば、「開発で生じる面倒な作業を自動化する」ための方法です。

ソフィアちゃん

繰り返し発生する作業はなるべく自動化したいですねっ！

GitHub Actionsを使おう

では、今回の主役「GitHub Actions」の紹介です。
GitHub Actionsは、GitHubが提供している「自動化ツール」です。リポジトリに変更が加えられたときに、決められた手順（＝ワークフロー）を自動で実行してくれます。

例えば、以下のようなことができます。

プルリクエストが来たときにテストを実行する
本番環境にコードをデプロイする
コードフォーマットをチェックする

GitHub Actionsはこのようなワークフローを比較的簡単に作成して実行できるようになっています。
しかもある程度は無料で使えます！😍

月間で実行できるワークフローの合計時間には上限があるので注意してください。

今回やること

今回は、GitHub Actionsを使ってC#のコードフォーマット（＝プログラムコードの体裁）をチェックする仕組みを作ります。使うツールはdotnet formatです。コードの見た目に問題があると教えてくれる便利なツールです。

gonzo

みんなは普段、コードフォーマットには気を遣ってるかﾆｬ？

ソフィアちゃん

自分以外の人に見せる必要があるコードは常に綺麗な形に保ちましょう♪

リポジトリの準備をしよう

1. GitHubリポジトリを準備する

自分のC#プロジェクトをGitHubに登録しましょう。リポジトリがまだなければ、新規作成してください。

2. .editorconfigを作る

.editorconfigは、コードフォーマットのルールを定義するファイルです。プロジェクトのルートディレクトリ等に以下の内容でファイルを作成しましょう。

# .editorconfigファイルのサンプル

root = true

[*.cs]

indent_style = space

indent_size = 4

end_of_line = lf

charset = utf-8

trim_trailing_whitespace = true

insert_final_newline = true

dotnet_sort_system_directives_first = true

dotnet_separate_import_directive_groups = true

これで、C#コードのインデントや改行、usingディレクティブの順序などが統一されます。

gonzo

UnityならC#スクリプトファイルがあるディレクトリに配置すると良いﾆｬ

GitHub Actionsを設定する

ワークフローファイルを作る

リポジトリの.github/workflowsディレクトリに移動し、format-check.ymlというファイルを作成します。
以下はC#コードのフォーマットチェックを行うGitHub Actionsのワークフローの例です。

# ワークフローの名前

name: Code Format Check

# mainブランチに対するプルリクエストが作られたら実行

on:

pull_request:

branches:

- main

# 実行するジョブ

jobs:

format-check:

runs-on: ubuntu-latest

steps:

- name: コードを取得

uses: actions/checkout@v4

- name: .NETをセットアップ

uses: actions/setup-dotnet@v4

with:

dotnet-version: 8.0.x

- name: dotnet formatをインストール

run: dotnet tool install --global dotnet-format

- name: フォーマットチェックを実行

run: |-

dotnet format ExampleApp.csproj \

--verify-no-changes \

--report ./format-check-report.json

- name: レポートを整形してアップロードする

if: failure()

run: |-

echo "ファイルパス | 行 | 列 | エラー内容" >> $GITHUB_STEP_SUMMARY

echo "--- | --- | --- | ---" >> $GITHUB_STEP_SUMMARY

cat ./format-check-report.json | jq -r --arg base "$(pwd)" \

この設定で、プルリクエストが作成されるたびにコードフォーマットがチェックされます。

gonzo

CI/CDのワークフローは大抵Linux環境で実行することになるから、その辺の知識も持ち合わせてると理解が捗るﾆｬｰ

ソフィアちゃん

GitHub ActionsではDocker等のコンテナ技術も応用できるので、知っていると大いに役立ちますねっ！🐳

実際に動かしてみよう

プロジェクトに変更を加えたら、GitHubでプルリクエストを作成してください。
ワークフローが自動的に動き、フォーマットに問題があればエラーを通知します。
Detailsリンクの先にあるSummaryでエラー箇所を確認します。
指摘された箇所を修正して再度プッシュしましょう！

以下が実際の流れです。
例えば、下記のようなプログラムコードをProgram.csというファイル名でコミットしたとします。

public class ExampleClass

{

public static void Main()

{

// インデントをしていない

string str = "Hello, World!";

// 行末に空白が入っている

Console.WriteLine(str);

// 空白行に余計なインデントが入っている

}

そして、プルリクエストを作るとワークフローが実行されます。

しばらくすると失敗します。

Summaryを見るとエラー箇所が表形式になっています。

修正後にコミットすると、再度ワークフローが実行されて、成功となります。

以上のように、GitHub Actionsとdotnet formatを組み合わせれば、このようにコードフォーマットのチェックを簡単に自動化できます。これを取り入れることで、開発チーム全体の効率やコードの品質がぐんと上がりますよ。

リポジトリの設定で、ワークフローが全てパスしないとマージができないようにする事も可能です。

他にもCI/CDでできること

CI/CDを使うと、他にも開発の面倒な作業を自動化できます。今回はいくつかの例をサクッとご紹介します。

自動テスト：
コードが正しく動くか、自動でチェック！ユニットテストや統合テストを使えば、バグを早期に発見できます。
自動ビルド：
コードを変更したら、実行ファイルやライブラリを自動生成！手作業でのミスも防げます。
本番環境へのデプロイ：
テストをクリアしたコードを自動で本番環境に反映。これでリリース作業も楽々！
コード品質チェック：
静的解析ツールで、コードの書き方やセキュリティリスクを自動チェック。チームのコードを統一できます。
ドキュメント生成：
コードからAPIドキュメントを自動生成。更新漏れも防げて安心！

gonzo

Unityの場合なんかは、metaファイルの上げ忘れ・削除し忘れを検知するワークフローを仕込んでおくと地味に便利だﾆｬｰ

おわりに

CI/CDは、開発を効率化する魔法のような仕組み。
テストやデプロイを自動化すれば、作業がぐっと楽になります。
特に近年はAIの導入も組み合わさって、コードレビューやデータ分析などの高度な作業も可能になってきています。
また、あらゆる開発支援ツールへの導入も進んできており、使っていて当たり前になってきているほどですので、まだ触ったことが無い方はぜひ試してみてくださいね！

ソフィアちゃん

面倒な作業はなるべく自動化して、製品のクオリティアップに注力できるようにしましょう♪

おしまい