はじめに

このドキュメントでは、CircleCI 2.0 で成功 (グリーン) ビルドを行うための詳しい手順を説明します。

ビルドにあたっての前提条件
リポジトリの作成
.yml ファイルの追加
CircleCI 上でのビルドの準備
CircleCI での初めてのビルド
ビルドを意図的に失敗させる
Workflows 機能の使用
Workspaces 機能を使ってみる
SSH でのビルドへの接続
関連情報

ビルドにあたっての前提条件

Git に関する基礎的な知識があり、GitHub のアカウントを所有している、もしくはアカウントを作成する権限があること。ここでは GitHub の新しいリポジトリを使用した手順を説明しますが、実際には Bitbucket も利用できます。
ターミナルや bash についての基本的な知識。またコマンドラインの使用経験があれば役に立ちます。

リポジトリの作成

GitHub.com で自分のアカウントに移動します。

[Repositories] タブに移動し、 [New] を選択するか、https://github.com/new に直接移動します。

[Initialize this repository with a README] にチェックを入れて、[Create repository] ボタンをクリックします。

.yml ファイルの追加

CircleCI は、テスト環境の構築方法や実行するテスト内容の定義に YAML ファイルを使います。 CircleCI 2.0 では、config.yml というファイル名で、隠しフォルダである .circleci ディレクトリ配下に作成しておく必要があります。 macOS、Linux、Windows においては、ピリオドから始まるファイルやフォルダは、デフォルトで隠し属性のあるシステムファイルとして扱われますので、ご注意ください。

GitHub でファイルやフォルダを作成するには、リポジトリページの [Create new file] ボタンをクリックし、.circleci/config.yml と入力します。空の config.yml ファイルが .circleci フォルダ内に作成されます。
単純な config.yml から始めたいときは、下記の内容を GitHub の編集画面にコピーしてください。

version: 2
jobs:
  build:
    docker:
      - image: circleci/ruby:2.4.1
    steps:
      - checkout
      - run: echo "A first hello"

コメントを入力してから、[Commit New File] ボタンをクリックしてファイルをコミットします。

- image: circleci/ruby:2.4.1 という部分は、プロジェクトをビルドする際にどの Docker イメージを使うか指定しているものです。 CircleCI は、イメージを使用して「コンテナ」を立ち上げます。コンテナとは、プロジェクトの実行に必要な言語、システムユーティリティ、依存関係、Web ブラウザー、ツールなどがインストールされる仮想コンピューティング環境です。

CircleCI 上でのビルドの準備

この手順を実行するには、CircleCI アカウントが必要です。 CircleCI のユーザー登録ページを開き、[GitHub でログイン] をクリックします。ビルドを実行するには、GitHub アカウントに CircleCI へのアクセスを許可する必要があります。 CircleCI アカウントを既に持っている場合は、ダッシュボードにアクセスします。
次に、CricleCI で既に構築され、自分がアクセス可能なプロジェクトをフォローするかどうかのオプションが表示されます (これは通常、会社や組織の GitHub アカウントを使用している開発者に表示されます)。次の画面では、作成したリポジトリを、新しいプロジェクトとして CircleCI に追加できます。
自分の新しいリポジトリを追加するには、左上のドロップダウンで自分の GitHub アカウントが選択されていることを確認してから、作成したリポジトリを下で見つけ、横にある [Set Up Project] ボタンをクリックします。
さらに次の画面ではプロジェクトに関する設定が可能です。この時点では設定はそのままでもかまいません。右下にある [Start building] ボタンをクリックしてください。

CircleCI での初めてのビルド

ビルドが開始され、自動的に正しく実行されるはずです。実行結果を確認します。CircleCI ダッシュボードに表示される緑色の [SUCCESS] ボタンをクリックすると、実行の次の部分を調べることができます。

環境のスピンアップ： CircleCI は、circleci/ruby:2.4.1 Docker イメージを使用して、仮想コンピューティング環境をローンチしました。
チェックアウトコード： CircleCI は、GitHub リポジトリをチェックアウトし、手順 1 でローンチされた仮想環境に「クローン」しました。
echo： これは、config.yml に含まれる唯一の他の命令です。CircleCI は「A first hello」という入力を echo コマンドに渡して実行します。 (echo コマンドは、入力された文字列をそのまま出力します)。

今のところはリポジトリにソースコードが含まれておらず、config.yml 内にもテストに関わる設定が含まれていませんが、CircleCI はビルドに「成功」したものとして扱います (exit コードとしては 0 を返しているため)。ほとんどのプロジェクトは、これよりはるかに複雑で、多くの場合は複数の Docker イメージと複数のステップが存在し、多くのテストも含まれます。 config.yml ファイルに記述できる全てのステップの詳細については、CircleCI の設定方法を参照してください。

ビルドを意図的に失敗させる

単純化のため、GitHub エディターで config.yml ファイルを編集し、echo "A first hello" を notacommand に置き換えます。 GitHub エディターの [Commit change] ボタンをクリックします。 CircleCI の Builds ページに戻ると、新しいビルドがトリガーされています。このビルドは失敗し、赤色の [FAILED] ボタンが表示され、失敗を通知するためのメールが送信されます。

Workflows 機能の使用

Workflows の動作を見るには、.circleci/config.yml ファイルを編集します。ブラウザーのウィンドウでファイルを編集モードにしてから、ファイル内で build とそれ以後のテキストを選択し、コピー＆ペーストし、そのセクションを複製します。コードブロックは次のようになります。

version: 2
jobs:
  build:
    docker:
      - image: circleci/ruby:2.4.1
    steps:
      - checkout
      - run: echo "A first hello"
  build:
    docker:
      - image: circleci/ruby:2.4.1
    steps:
      - checkout
      - run: echo "A first hello"

次に、2 つのジョブを別々の名前にします。この例では、one と two という名前にします。 echo コマンドの部分も別のものに変更します。ビルドの実行に必要な時間をあえて長くするため、システムの sleep コマンドを追加します。
config.yml に workflows セクションを追加します。workflows セクションは、ファイルのどこにでも配置できます。通常は、ファイルの先頭または末尾に配置します。

jobs:
  one:
    docker:
      - image: circleci/ruby:2.4.1
    steps:
      - checkout
      - run: echo "A first hello"
      - run: sleep 25
  two:
    docker:
      - image: circleci/ruby:2.4.1
    steps:
      - checkout
      - run: echo "A more familiar hi"
      - run: sleep 15
workflows:
  version: 2
  one_and_two:
    jobs:
      - one
      - two

これらの変更をリポジトリにコミットしてから、CircleCI のダッシュボードに戻ります。
Workflow のリンクをクリックすると、2 つのジョブが並列実行されていることを確認できます。

Workflows の詳細については、「Workflows の制御」ドキュメントを参照してください。

Workspaces 機能を使ってみる

各 Workflow には Workspace が割り当てられています。Workspace は、Workflow の進行につれてダウンストリームのジョブにファイルを転送するために使用されます。 Workspaces を使用して、その実行に固有のダウンストリームのジョブで必要となるデータを渡すことができます。 config.yml を次のように書き換えてみてください。

version: 2
jobs:
  one:
    docker:
      - image: circleci/ruby:2.4.1
    steps:
      - checkout
      - run: echo "A first hello"
      - run: mkdir -p my_workspace
      - run: echo "Trying out workspaces" > my_workspace/echo-output
      - persist_to_workspace:
          # 絶対パス、または working_directory からの相対パスにする必要があります
          root: my_workspace
          # root からの相対パスにする必要があります
          paths:
            - echo-output
  two:
    docker:
      - image: circleci/ruby:2.4.1
    steps:
      - checkout
      - run: echo "A more familiar hi"
      - attach_workspace:
          # 絶対パス、または working_directory からの相対パスにする必要があります
          at: my_workspace

      - run: |
          if [[ $(cat my_workspace/echo-output) == "Trying out workspaces" ]]; then
            echo "It worked!";
          else
            echo "Nope!"; exit 1
          fi
workflows:
  version: 2
  one_and_two:
    jobs:
      - one
      - two:
          requires:
            - one

Workspaces の詳細については、こちらを参照してください。

SSH でのビルドへの接続

ターミナルの操作に慣れている場合、SSH enabled オプションでビルドを再実行することで、CircleCI のジョブに SSH で直接接続してビルドのトラブルシューティングを行えます。

この場合、GitHub アカウントに SSH キーを追加する必要があることに注意してください。詳細については、https://help.github.com/articles/connecting-to-github-with-ssh/ を参照してください。

ビルドの SSH の有効化セクションから、ssh の接続先をコピーします。ターミナルを開き、ssh の接続先を貼り付けます。

以下のコマンドのいくつかを使用すると、Workspaces を使用して作成したファイルの内容を検索し、表示できます。

pwd     # print what directory の略で、現在のディレクトリがファイルシステムのどこなのかを確認できます
ls -al   # list の略で、現在のディレクトリに存在するファイルとディレクトリを一覧表示します
cd <directory_name>    # ディレクトリを <directory_name> ディレクトリに変更します
cat <file_name>    # <file_name> で指定したファイルの内容を表示します

Search Results for ""