リポジトリの準備
CI/CDパイプラインを構築するためには、まず対象となるアプリケーションのソースコードを管理するGitリポジトリが必要です。GitHub Actionsはリポジトリに格納されたコードに対して動作するため、ここでは自身のGitHubアカウントにリポジトリを用意し、ローカル環境でコードを編集できる状態を整えます。
1. GitHubで空のリポジトリを作成
今回のハンズオンではFastAPIで作成済みのサンプルAPIをCI/CDパイプラインの対象とします。ゼロからアプリケーションを作るとCI/CDの学習に集中できないため、準備済みのサンプルコードを使う形で進めます。
実務に近い形を体験するために、ご自身のGitHubアカウントで新しいリポジトリを作成し、そこにサンプルコードを配置する流れで進めます。自分が作ったリポジトリに対してCI/CDパイプラインを構築することで、実感が湧きやすい体験ができます。
GitHubにログインし、右上の+ボタンからNew repositoryをクリックします。
以下の設定でリポジトリを作成します。
| 設定項目 | 値 | 設定の基準 |
|---|---|---|
| Owner | ご自身のGitHubアカウント | 自分のアカウントで管理するため |
| Repository name | devopscamp-cicd-handson | ハンズオン用のリポジトリ名 |
| Visibility | Public | GitHub Actionsの無料実行時間を気にせず使えるため |
| 💡 ポイント |
|---|
リポジトリ名は任意ですが、後のOIDC設定でこのリポジトリ名を使うため、覚えておきやすい名前にしておきましょう。本章ではdevopscamp-cicd-handsonという名前で進めます。 |
Create repositoryボタンをクリックしてリポジトリを作成します。

作成後、「Quick setup」の画面が表示されたら、ここでは何も操作せずに次のステップに進みます。
2. サンプルコードのダウンロード
リモートリポジトリの器ができたので、次はそこに配置するアプリケーションのソースコードを準備します。今回はFastAPIで作成済みのシンプルなAPIを利用するため、以下のボタンからサンプルコードのZIPファイルをダウンロードしてください。
ダウンロードしたZIPファイルを、任意の場所に解凍してください。解凍するとdevopscamp-cicd-handsonという名前のフォルダができます。このフォルダの中身は以下のようになっています。
devopscamp-cicd-handson/
├── Dockerfile
├── requirements.txt
└── main.py
各ファイルの役割を以下の表にまとめます。
| ファイル名 | 役割 |
|---|---|
main.py |
FastAPIアプリケーションのエントリーポイント。ヘルスチェック用のエンドポイントと、動作確認用のメッセージを返すエンドポイントが記述されている |
requirements.txt |
Pythonプロジェクトで利用するパッケージの一覧を記載したファイル。pip installでこれらをインストールする |
Dockerfile |
コンテナイメージを作成するための手順を記述した設定ファイル。自動ビルドの際にはこの内容に従ってビルドが実行される |
main.pyの中身は以下のとおりで、ヘルスチェック用の/healthと、動作確認用の/の2つのエンドポイントだけを持つシンプルな構成です。
from fastapi import FastAPI
app = FastAPI()
@app.get("/health")
def health():
return {"status": "ok"}
@app.get("/")
def root():
return {"message": "API呼び出しテストに成功しました"}
今回のハンズオンではCI/CDパイプラインの構築が主題のため、APIの中身はあえて最小限にしています。のちほどこのメッセージを書き換えてPushすることで、自動デプロイが動いてアプリケーションが更新される様子を体験します。
3. Gitリポジトリとして初期化
ダウンロードしたサンプルコードは、まだただのフォルダであり、Gitの管理下に入っていません。このままではGitHubへPushできないため、devopscamp-cicd-handsonフォルダをGitリポジトリとして初期化し、最初のコミットを作成します。
Visual Studio Codeでdevopscamp-cicd-handsonフォルダを開き、ターミナルを開きます。
以下のコマンドで、Git がインストールされていることを確認します。
git --version
以下のように Git のバージョンが表示されれば、インストールは確認できています。
git version 2.x.x
バージョンが表示されない場合は、Git/GitHubのセットアップ を先に実施してください。
インストールが確認できたら、以下のコマンドを実行します。
まず、フォルダをGitリポジトリとして初期化します。
git init
以下のような実行結果が表示されます。
Initialized empty Git repository in /path/to/devopscamp-cicd-handson/.git/
次に、すべてのファイルをステージングします。
git add .
ステージングしたファイルをコミットします。
git commit -m "initial commit"
git logなどで初回コミットが作成されていれば、ここまでの操作は完了です。
4. リモートリポジトリの登録とPush
ローカルでコミットを作成しただけでは、GitHub上のリモートリポジトリにはまだ何も反映されていません。CI/CDパイプラインはGitHub上のコードに対して動作するため、ローカルリポジトリと先ほど作成したGitHubリポジトリを紐付け、Pushしてコードを反映させます。
まず、ローカルのブランチ名をmainに統一します。Gitのバージョンによっては初期ブランチ名がmasterになっていることがあるため、念のため明示的に変更します。
git branch -M main
次に、先ほど作成したGitHubリポジトリをリモートリポジトリとして登録します。<your-github-account-name>の部分はご自身のGitHubアカウント名に置き換えてください。
git remote add origin https://github.com/<your-github-account-name>/devopscamp-cicd-handson.git
| 📝 git remoteとは |
|---|
git remoteは、ローカルリポジトリと連携するリモートリポジトリを管理するコマンドです。originはリモートリポジトリに付ける慣習的な名前で、これ以降git push origin mainのようにoriginという名前でGitHubのリポジトリを指し示せるようになります。 |
最後に、コミットしたコードをリモートリポジトリにPushします。
git push -u origin main
-uオプションを付けることで、以降はgit pushだけで同じブランチにPushできるようになります。
GitHubのリポジトリページをブラウザで開き、main.pyやDockerfileなどのファイルが表示されていれば、ここまでの操作は完了です。
