CircleCIでアイドル情報を出力させて生産性を上げる話

9 min readApr 8, 2019

この内容は技術書典6にて頒布する第2回IM@Study合同本企画への寄稿内容です。
IM@Study | 技術書典6「か48」
https://techbookfest.org/event/tbf06/circle/54670006

本チャプタの対象者

なにかしらソフトウェアを開発しているエンジニア
GitHubを利用してソースコードや文書を管理している人

はじめに

この本を読んでいるプロデューサーエンジニアのみなさんはだいたい副業でエンジニアをやっているかたがほとんどだと思われます。とくにWeb、ネイティブアプリ、ゲームなどといったソフトウェアを開発していると思います。

開発をする中で生産性をあげるツールとしてCIがあるのですが、CIを使用してアイドル情報を取得することでプロデューサーエンジニアとしてより生産性が上がると思いませんか？

今回はアイドルの情報の中でも、CircleCIを使用して「今日が誕生日のアイドルを取得する」方法について触れます。

CircleCIとは

CircleCI(*1)とは継続的なインテグレーションサービスの一つです。コミットからテスト、デプロイなどユーザが設定した情報を元に自動で行うことができます。

CircleCIにはCircleCI Orbs(*2)というCircleCIの設定ファイルのコマンドや設定などの共通処理を使い回すことができる仕組みがあります。この仕組みの使い方は「あるRuby on Railsのプロジェクトのテストコマンドは他のRuby on Railsのプロジェクトとほぼ同じだから使い回したい」ときや「あるPythonのプロジェクトのライブラリ読み込みコマンドは他のPythonのプロジェクトとほぼ同じだから共通化したい」といったことがあったときにとても有用です。

この仕組みを利用して著者が作成した「今日が誕生日のアイドルを出力する」のOrbsを導入してみます。

今回はCircleCIの詳しい使い方には触れません。

\*1：https://circleci.jp/
\*2：https://circleci.com/orbs/

著者が実装したOrbsを導入する

最初に作業の流れを確認します。

GitHubにリポジトリを作る
CircleCIにサインアップする
CircleCIにプロジェクトを追加する
CircleCI 2.1を有効にする
.circleci/config.yml を書く
GitHubにpushしてCircleCIの実行結果を確認する
CircleCIの実行結果を見てみる

GitHubにリポジトリを作る

GitHubにリポジトリを作ります。すでに作成されたリポジトリで試す場合はここではとくに何もしません。

CircleCIにサインアップする

https://circleci.jp/ にアクセスをしてサインアップします。すでにアカウントがある場合はそれを使用しても構いません。

CircleCIにプロジェクトを追加する

プロジェクトを追加します。GitHubのリポジトリを検索して Set Up Project をクリックします。

セットアップページが表示されますが、ここではなにもせずに Start building をします。(ここでbuildをしても必ず失敗するので、失敗のログを残したくないのであれば次に設定する.circleci/config.ymlを作成し、exampleにあるコードを書いてGitHubにプッシュします)

CircleCI 2.1を有効にする

Start buildingをクリックしたあとに表示されるページの右上の歯車アイコンからプロジェクトの設定をします。

その中にある Advances Settingsから Ennable build processing (preview)を有効にします。

`.circleci/config.yml` を書く

ここで実際に設定を書いていきます。 .circleci/config.ymlに以下のコードを書きます。この設定で「今日が誕生日のアイドルを取得する」ことができます。

version: 2.1
ubuntu_image: &ubuntu_image
  ubuntu:18.04
install-sudo: &install-sudo |
  apt-get update
  apt-get install -y sudo
orbs:
  todays-imas-idol: yutagoto/todays-imas-idol@1.0.0executors:
  ubuntu-docker:
    docker:
      - image: *ubuntu_image
        environment:
          TZ: Asia/Tokyojobs:
  echo:
    executor: ubuntu-docker
    steps:
      - run:
          command: *install-sudo
      - todays-imas-idol/echo-todays-imas-idolworkflows:
  main:
    jobs:
      - echo

上記はubuntuを使用していますが、各プロジェクトに合わせて使用するimageを変更してください(著者のrubyのプロジェクトでも動作確認はできています)。

それぞれの設定コードの解説

version: 2.1

使用するCircleCIのバージョンを指定します。

ubuntu_image: &ubuntu_image
  ubuntu:18.04
install-sudo: &install-sudo |
  apt-get update
  apt-get install -y sudo

この設定ファイルで使用する変数を定義します。デフォルトのubuntuではデフォルトでsudoがインストールされていないのでsudoをインストールしていますが、sudoを使える環境であればこの設定は不要です。

executors:
  ubuntu-docker:
    docker:
      - image: *ubuntu_image
        environment:
          TZ: Asia/Tokyo

実行環境の情報を定義して再利用するコードを定義します。

orbs:
  todays-imas-idol: yutagoto/todays-imas-idol@1.0.0

使用するOrbsを定義します。今回は yutagoto/todays-imas-idol@1.0.0(*3)を使用します。

\*3：https://circleci.com/orbs/registry/orb/yutagoto/todays-imas-idol

jobs:
  echo:
    executor: ubuntu-docker
    steps:
      - run:
          command: *install-sudo
      - todays-imas-idol/echo-todays-imas-idolworkflows:
  main:
    jobs:
      - echo

実際に処理する内容になります。 jobs:でそのjobの名前(この場合はecho)と、workflows:で処理する順番を定義します。

jobsのstepsに todays-imas-idol/echo-todays-imas-idol を書きます。

GitHubにpushしてCircleCIの実行結果を確認する

GitHubにpushして、CircleCIの実行結果をみてみます。

ここで今日が誕生日のアイドルを確認することができます。今日が誕生日のアイドルがいない場合はnullが出力されます。

yutagoto/todays-imas-idol@1.0.0 の他の使い方

いままでの例ではCircleCIの実行結果に標準出力してアイドルを確認していましたが、このOrbsにはSlackやDiscordへの通知にも対応しているので、わざわざ実行結果のページに遷移しなくともアイドルを感じることができます。くわしい使い方はOrbsのページ(*4)を参照してください。以下にSlackへの通知の実行結果の例を載せます。