GitHub Actions は GitHub に組み込まれた CI/CD (継続的インテグレーション/継続的デリバリー) プラットフォームです。リポジトリへのプッシュや PR の作成をトリガーに、自動ビルド・テスト・デプロイなどのワークフローを実行できます。YAML ファイルでワークフローを定義し、.github/workflows/ ディレクトリに配置します。
このリポジトリは GitHub Actions を使用して、C コードのビルド・テスト・カバレッジ計測・ドキュメント生成・GitHub Pages へのデプロイを自動化しています。PR のマージ前に自動テストを実行することで、コードの品質を継続的に維持できます。
GitHub Actions のワークフローを理解することで、CI の実行状況の確認、失敗時の原因調査、新たな自動化の追加ができるようになります。
on で使えるイベント一覧このリポジトリのワークフロー (.github/workflows/ 配下) が担当する処理:
| ジョブ | 内容 |
|---|---|
| build | C コードのビルド(Linux / Windows) |
| test | Google Test の実行・結果収集 |
| coverage | gcov / lcov によるカバレッジ計測 |
| docs | Doxygen・Pandoc によるドキュメント生成 |
| deploy | GitHub Pages へのドキュメント公開 |
ワークフロー YAML の基本構造:
name: CI
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: チェックアウト(サブモジュール含む)
uses: actions/checkout@v4
with:
submodules: recursive
- name: C コードのビルド
run: make
- name: テストの実行
run: make test