GitHub CI/CD チュートリアル: 継続的インテグレーションのセットアップ
フルスタック デベロッパー兼テクニカル ライター
継続的インテグレーション (CI) では、プロジェクトのメインの Git ブランチにマージする前に、機能ブランチのテストを自動化します。これにより、不具合を引き起こすような変更でコードベースが更新されるのを防げます。一方、継続的デリバリー (CD) は CI をベースに、これらのブランチやメインブランチのリリースを自動化します。これにより、小さな増分更新をより速くユーザーに届けられます。これは アジャイルソフトウェア開発の手法にも沿ったやり方です。
この記事では、GitHub と CircleCI を使って CI パイプラインをセットアップする手順を説明します。デモにはシンプルな Python アプリケーションを使いますが、ご自身のプロジェクトで試しながら進めることもできます。
手順は次のとおりです。
- シンプルな Python アプリケーションを作成する (Flask を使用)
- このアプリのテストを作成する
config.ymlファイルを追加する- GitHub にプッシュする
- CircleCI を設定する
READMEにバッジを追加する- PR を作成して CircleCI の動作を確認する
前提条件
このチュートリアルを進めるには、次のものが必要です。
- ローカル環境に Python がインストールされていること
- CircleCI のアカウント
- GitHub のアカウント
このチュートリアルの完全なコードは、GitHub の CIRCLECI-GWP/python_app リポジトリにあります。
シンプルな Python アプリの作成とビルド
シンプルにするために、Flask アプリケーションを作成します。Flask は Python のマイクロフレームワークです。Flask を使ったことがなくても心配はいりません。ここで作るのは、Flask のドキュメントにある基本的な hello world アプリケーションです。
まず、プロジェクトディレクトリ (フォルダー) を作成し、cd でそこに移動します。ターミナルに次のように入力します。
mkdir python_app && cd $_/
次に、お好みのエディターを開いて hello.py ファイルを作成します。そのファイルに次の行をコピーします。
from flask import Flask
app = Flask(__name__)
@app.route("/")
def hello_world():
return "<p>Hello, World!</p>"
Python の仮想環境
Python で作業する場合は、仮想環境を使うことを強くお勧めします。仮想環境を使うと、ローカルマシン全体ではなく、分離された環境に Python パッケージをインストールできます。
一般的な方法としては、virtualenv や、さらに便利な virtualenvwrapper を使う方法があります。ここでは、Python3 に標準で含まれている venv モジュールを使います。手順は次のとおりです。
- 仮想環境を作成します。
python -m venv .venv
システムに python コマンドがない場合 (macOS 向けの python.org インストーラーでは python3 が提供されます) は、代わりに python3 を使ってください。
次の例のように、仮想環境には別の名前を付けることもできます。
python -m venv Env
- この環境をアクティブ化します。
source .venv/bin/activate
環境に別の名前を付けた場合は、.venv をその名前に置き換えてください。シェルプロンプトの直前に環境名が表示され、仮想環境がアクティブになっていることがわかります。これ以降にインストールする Python パッケージは、すべてこの環境内にインストールされます。この環境を非アクティブ化するには、次のコマンドを実行するだけです。
deactivate
アプリの実行
次に、エディターで requirements.txt ファイルを作成します。次の内容を追加します。
Flask
pytest
このファイルでは、アプリケーションが依存するパッケージを指定します。これらのパッケージは、Python のパッケージマネージャーである pip を使ってインストールできます。
次に、仮想環境内で次のコマンドを実行して、パッケージをインストールします。
pip install -r requirements.txt
注: この手順の前に仮想環境を非アクティブ化した場合は、まず source .venv/bin/activate を実行する必要があります。
最後に、次のコマンドでアプリケーションを実行します。
flask --app hello run
ブラウザーで http://localhost:5000/ にアクセスすると、アプリケーションが実行されていることを確認できます。
アプリケーションのテストの作成
ソフトウェアテストは、どの開発者にとっても重要なスキルです。アプリケーションが意図したとおりに動作することを確認し、バグを早期に発見するのに役立ちます。テストを書いておけば、後々の時間と手間を節約できます。
エディターで test_hello.py ファイルを作成し、次の行を貼り付けます。
from hello import app
def test_home_route():
with app.test_client() as c:
response = c.get("/")
assert response.data == b"<p>Hello, World!</p>"
assert response.status_code == 200
このテストでは、Flask アプリケーションのホームルートが正しい HTML コンテンツとステータスコードを返すことを確認します。
詳しくは、Pytest を使った Flask のテストをご覧ください。
では、テストを実行してみましょう。ターミナルを開いて次のコマンドを実行します。
python -m pytest
このコマンドは、先ほど作成したテストファイルを実行します。すべて正しくセットアップされていれば、次のような出力が表示されます。
============================= test session starts ==============================
platform linux -- Python 3.15.1, pytest-9.1.1, pluggy-1.7.0
rootdir: /home/reader/python_app
collected 1 item
test_hello.py . [100%]
============================== 1 passed in 0.08s ===============================
この出力は、テストが成功したことを示しています。ドット (.) は成功したテストを表し、F は失敗を表します。
CircleCI の設定ファイルの作成
テストのプロセスを自動化するには、CircleCI の設定ファイルを用意する必要があります。この設定ファイルで、テストの実行方法と、アプリケーションのビルドおよびテストの方法を定義します。
.circleci フォルダーを作成し、その中に config.yml ファイルを作成します。そのファイルに次の行をコピーします。
version: 2.1
orbs:
python: circleci/python@4.0.0
jobs:
build_and_test: # this can be any name you choose
executor: python/default # use the default executor defined within the orb
steps:
- checkout # checkout source code
- python/install-packages:
pkg-manager: pip
pip-dependency-file: requirements.txt
- run:
name: Run tests
command: python -m pytest
workflows:
build_test_deploy:
jobs:
- build_and_test
このファイルは、CircleCI で Python Orb を使うように設定します。Orb を使うと、Python 環境のセットアップとテストの実行が簡単になります。build_and_test ジョブは、ソースコードをチェックアウトし、必要なパッケージをインストールして、pytest でテストを実行します。workflows セクションでは、build_and_test ジョブを実行する build_test_deploy というワークフローを定義しています。
この設定ファイルについて詳しく見る
GitHub へのプッシュ
DevOps のベストプラクティスに従うなら、通常はプロジェクトの最初に Git を初期化し、小さなコミットをこまめに行います。ただし、このチュートリアルは CircleCI と GitHub の連携に焦点を当てているため、あえてこの手順をここまで後回しにしました。
現在のコード構成は次のとおりです。
.
├── .circleci
│ └── config.yml
├── hello.py
├── requirements.txt
└── test_hello.py
エディターを開き、作業ディレクトリに .gitignore ファイルを作成します。このファイルで、Git にコミット_したくない_ファイルやフォルダーを指定します。このファイルに次の行をコピーします。
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
# Environments
.env
.venv
env/
venv/
ENV/
次のコマンドを実行して、Git を初期化し、コードをコミットします。
git init
git add .
git commit -m "initial commit"
GitHub のアカウントをまだ持っていない場合は、GitHub のホームページにアクセスしてアカウントを作成してください。GitHub を初めて使う場合は、プロジェクトを GitHub にプッシュする方法のチュートリアル (英語) を読んでおくとよいでしょう。
次に、github.com/new にアクセスしてリポジトリを作成します。
名前には python_app を使います。その他の設定はデフォルトのままにして、Create repository をクリックします。
新しいリポジトリを作成すると、リポジトリのセットアップ方法が表示されます。
次のコマンドを実行して、リモートリポジトリを追加し、コードを GitHub にプッシュします。<your-username> は、リポジトリを所有する GitHub のユーザー名に置き換えてください。
git branch -M main
git remote add origin https://github.com/<your-username>/python_app.git
git push -u origin main
CircleCI の設定
リポジトリが GitHub にプッシュされたので、CircleCI を設定して CI パイプラインを完成させましょう。CircleCI のサインアップページにアクセスし、Sign up をクリックして CircleCI のアカウントを作成します。GitHub との接続は、後でプロジェクトを作成するときに行います。
仕事用のメールアドレスを入力して Continue をクリックし、パスワードを作成します。
アカウントを確認するためのメールが届きます。メール内のリンクをクリックして、アカウントを確認します。
次の画面で、いくつかのオンボーディングの質問に選択肢から回答します。ここでは一般的なものを選びました。
Let’s go をクリックして続行します。
次に、新しい組織を作成します。
組織の名前を入力します。これは CircleCI アカウントを識別するために使われる名前です。Let’s go をクリックして続行します。
これで CircleCI 上に新しい組織が作成されます。続いて、組織の Organization Home ページにリダイレクトされます。Create a project をクリックします。
プロジェクトに python_app のようなわかりやすい名前を付けて、Next をクリックします。CircleCI は最初のパイプライン名として build-and-test を提案します。このチュートリアルではその名前のままでかまいません。
次に、リポジトリを選択します。Connect your VCS provider and select your target repo で GitHub Cloud を選択します。
初めて GitHub に接続すると、CircleCI GitHub App がインストールされます。python_app リポジトリを所有している GitHub のアカウントまたは組織を選択します。
CircleCI がアクセスできるリポジトリを個別に指定することも、GitHub 組織内のすべてのリポジトリへのアクセスを許可することもできます。All repositories または Only select repositories を選択し、Install & Authorize をクリックします。
GitHub から CircleCI に戻ったら、一覧から python_app リポジトリを選択します。
次に、トリガーを設定します。Choose your starting trigger では、デフォルトで All pushes が選択されています。この場合、リポジトリへのすべてのプッシュでパイプラインが実行されます。
このチュートリアルではデフォルトのトリガーで十分なので、そのままにして Next をクリックします。
リポジトリにはすでに .circleci/config.yml ファイルがあるため、CircleCI がそれを検出し、CircleCI config detected と表示されます。Next をクリックすると、Review and finish ページに Config detected と表示されます。Go to project をクリックします。
これで、CircleCI 上のプロジェクトの準備ができました。
プロジェクトが作成されると、パイプラインのページに移動します。CircleCI は、指定された .circleci/config.yml ファイルを使ってパイプラインを実行します。
パイプラインは、次にリポジトリにプッシュしたときに実行されます。今すぐ最初の実行を開始するには、Trigger pipeline をクリックします。Config Source と Checkout Source の両方で main ブランチを選択し、Run pipeline をクリックします。
パイプラインのページで出力を確認できます。すぐにビルドが成功します。完了です。
プロジェクトのセットアップが完了したら、利用できるオプションの設定にも慣れておくとよいでしょう。関連する例を 1 つ見てみましょう。
このプロジェクトで Project をクリックし、Project settings を選択してから、左側の Project Setup をクリックします。
build-and-test パイプラインには、All pushes というトリガーが 1 つあります。つまり、PR を含め、GitHub へのすべてのプッシュが CircleCI で実行されます。ビルドの頻度を減らすには、トリガーを展開して Edit trigger をクリックし、PR opened or pushed to, default branch and tag pushes などの別のイベントを選択します。大規模なチームでは、この設定でビルド時間の消費を抑えられる場合があります。
config.yml がない場合の CircleCI のセットアップ
リポジトリにまだ .circleci/config.yml ファイルがない場合、CircleCI は AI コーディングエージェントに貼り付けるためのプロンプトを提供します。エージェントが設定ファイルを生成し、リポジトリの新しいブランチにコミットします。すでに GitHub Actions を使っているプロジェクトの場合は、代わりに Use existing GitHub Actions workflow file を選択します。このチュートリアルでは、先ほど作成した設定ファイルを使います。
GitHub への CI ステータスバッジの追加
ステータスバッジを使うと、プロジェクトのビルドステータスを GitHub リポジトリ上で直接示せます。最新のビルドが成功したか失敗したかをひと目で確認できるので、自分にとっても共同作業者にとっても便利です。
ローカルマシンで次のコマンドを実行して、別の Git ブランチにチェックアウトします。
git checkout -b add_readme
エディターを開いて README.md ファイルを作成します。このファイルに次の行をコピーして貼り付けます。
# PYTHON APPLICATION
This Python application repo was created to showcase the integration between GitHub and CircleCI.
[](https://dl.circleci.com/status-badge/redirect/circleci/<org-id>/<project-id>/tree/main)
これで、タイトル、説明、ステータスバッジが追加されます。
最後の行は、プロジェクト固有のバッジコードに置き換えてください。CircleCI で Project をクリックし、Project settings を選択してから、Status Badges をクリックします。デフォルトでは Branch が main、Format が Markdown になっているので、Copy をクリックします。プライベートリポジトリの場合は、バッジが読み込まれるように、先にこのページで Add API token をクリックしてください。
次に、以下のコマンドを実行します。
git add .
git commit -m "Add README"
git push -u origin add_readme
https://github.com/<your-username>/python_app リポジトリに、新しいブランチ add_readme ができています。Compare & pull request をクリックします。
プルリクエストによるビルドのトリガー
ステータスバッジを追加したら、次はプルリクエスト (PR) を作成して、変更をメインブランチにマージします。これにより、ビルドをトリガーして、すべてが正しくセットアップされていることを確認できます。
私は次のように PR を作成しました。PR のタイトルは、コミットメッセージから自動的に生成されます。この内容は任意です。
#### What does this PR do?
Adds README.md file and a CircleCI badge in it.
Create pull request をクリックすると、すぐにビルドが成功します。
下向きのシェブロン矢印アイコンをクリックすると、成功したチェックが CircleCI からのものであることがわかります。ブラウザーのタブのファビコンにも、成功を示す緑色のチェックマークが表示されます。
ci/circleci: build_and_test の横にある Details をクリックすると、CircleCI のビルドにリダイレクトされます。
ここでもファビコンが緑色になっており、ビルドが成功したことがわかります。
PR をマージしましょう。必要に応じて、ブランチを削除してもかまいません。
これにより、パイプラインが再び実行されます。今回はメインブランチ上で実行されます。CircleCI のダッシュボードで確認できます。
まとめ
これで完了です。GitHub と CircleCI を連携させることができました。
まとめると、Python アプリケーションをセットアップし、そのテストを作成しました。次に、CircleCI の設定ファイルを作成し、コードベースを GitHub にプッシュしました。最後に、作成した GitHub リポジトリを CircleCI に接続しました。
ワークフローに継続的インテグレーションを取り入れると、テストが自動化され、コードを常にデプロイ可能な状態に保てます。これにより、バグを早期に発見し、コードの品質を高め、より速く確実に更新できるようになります。
ここまでの手順を完了できれば、ご自身のプロジェクトを GitHub にセットアップし、CircleCI で CI ビルドを設定できるはずです。次のステップとして、Flask アプリケーションのデプロイの自動化を追加して CI/CD パイプラインを完成させ、開発ワークフローを完全に自動化することを検討してみてください。チームで GitHub Actions も使っている場合は、GitHub Actions のワークフローから CircleCI のパイプラインを直接トリガー (英語) して、両方のプラットフォームを組み合わせることもできます。