リポジトリの準備

CI/CDパイプラインを構築するためには、まず対象となるソースコードを管理するGitリポジトリが必要です。GitHub Actionsはリポジトリに格納されたコードに対して動作するため、ここでは自身のGitHubアカウントにリポジトリを用意し、ローカル環境でコードを編集できる状態を整えます。

1. GitHubでの空リポジトリの作成

今回のハンズオンの主役は「GitHub Actionsのワークフロー」であり、題材となるPythonコード自体はごく簡単なものを使います。ゼロから本格的なアプリケーションを作る必要はなく、このあとの手順で数ファイルだけ作成すれば十分です。

実務に近い形を体験するために、ご自身のGitHubアカウントで新しいリポジトリを作成し、そこにサンプルコードを配置する流れで進めます。自分が作ったリポジトリに対してCIを構築することで、実感が湧きやすい体験ができます。

GitHubにログインし、右上の+ボタンからNew repositoryをクリックします。

以下の設定でリポジトリを作成します。

設定項目 値 設定の基準
Owner ご自身のGitHubアカウント 自分のアカウントで管理するため
Repository name devopscamp-ci-handson ハンズオン用のリポジトリ名
Visibility Public GitHub Actionsの無料実行時間を気にせず使えるため
Initialize this repository with 何もチェックしない 後から自分でファイルをPushするため
💡 ポイント
リポジトリ名は任意ですが、後のハンズオンで参照するため、覚えておきやすい名前にしておきましょう。本章ではdevopscamp-ci-handsonという名前で進めます。

Create repositoryボタンをクリックしてリポジトリを作成します。

作成後、「Quick setup」の画面が表示されたら、ここでは何も操作せずに次のステップに進みます。

2. リポジトリのClone

作成したリポジトリはGitHub上に存在するだけで、ローカル環境ではまだ編集できません。このあとサンプルコードを配置したり、ワークフローファイルを追加したりするために、まずローカル環境にclone(コピー)します。

ローカル環境で、Windowsであればコマンドプロンプト、Macであればターミナルを開きます。

以下のコマンドで、Git がインストールされていることを確認します。

git --version

以下のように Git のバージョンが表示されれば、インストールは確認できています。

git version 2.x.x

バージョンが表示されない場合は、Git/GitHubのセットアップ を先に実施してください。

インストールが確認できたら、下記のgit cloneコマンドを実行します。<your-github-account-name>の部分はご自身のGitHubアカウント名に置き換えてください。

git clone https://github.com/<your-github-account-name>/devopscamp-ci-handson.git

空のリポジトリなので、cloneするとYou appear to have cloned an empty repository.という警告が表示されますが、問題ありません。これは「リポジトリの中身がまだ空である」という意味です。

cloneしたフォルダ(devopscamp-ci-handson)がローカル環境に作成されていれば、ここまでの操作は完了です。

3. サンプルコードの作成

ローカル環境に作業用フォルダが用意できたので、次はそこに配置するソースコードを作成します。CIの仕組みを確かめるために、テスト対象となるPythonコードを用意します。

Visual Studio Codeでdevopscamp-ci-handsonフォルダを開きます。「ファイル」→「フォルダーを開く」から、先ほどcloneしたdevopscamp-ci-handsonのフォルダを選択してください。

フォルダを開いたら、リポジトリ直下にcalculator.pyというファイルを作成します。

devopscamp-ci-handson/
└── calculator.py  ← このファイルを作成

作成したファイルに以下の内容を記述して保存します。

import os

def add(a: int, b: int) -> int:
    return a + b


def subtract(a: int, b: int) -> int:
    return a - b

このファイルには、2つの整数を足し算・引き算する簡単な関数を定義しています。先頭のimport osは意図的に入れています。このインポートはコード内で一度も使われていないため、静的解析で検出される「問題のあるコード」の例として使います。CIが実際にエラーを検知する様子を後ほど確認します。

Visual Studio Codeのエクスプローラにcalculator.pyが表示されていれば、ここまでの操作は完了です。

4. 初回コミットとPush

ローカルリポジトリにコードを作成しただけでは、GitHub上のリモートリポジトリにはまだ何も反映されていません。CI/CDパイプラインはGitHub上のコードに対して動作するため、ここで初回のコミットとPushを行い、リモートリポジトリにコードを反映させます。

Visual Studio Codeのターミナルを開き、以下のコマンドを1つずつ実行します。

まず、作成したファイルをステージングします。

git add .

続いて、コミットします。

git commit -m "initial commit"

最後に、リモートリポジトリにPushします。

git push origin main

GitHubのリポジトリページを更新すると、calculator.pyが表示されます。これが表示されていれば、ここまでの操作は完了です。