GitHubで新しいActionsが使えるようになっていたのでCI/CDをやってみた

先日GitHubがCI/CDをサポートをする、というアナウンスメントがあってベータ版をスタートしたとありましたが、使えるようになったので使ってみました。

GitHub Action新旧
以前のGitHub Actions
新しいGitHub Actions
とりあえずやってみる
設定項目
実行制限
料金
他CIサービスの状況
まとめ

GitHub Action新旧

GitHub Actionsという物自体は昨年アナウンスされベータ版として使える様になってました。それが今月CI/CDを使えるようになった、というので話題になってたので使ってみようとしたところ、なんか違うものしか見れなくて(最初のベータ版に申し込んで出たものと同じもの) なんだろう、と思ってたんですが、新しいものに変更されるのも徐々に行われていたようです。

メールが来てやっと新しいものが使える様になったので使ってみました。

Actionsが使える様になっていても下に書くように古いままの場合には新しいベータが使える様になったというメールを心待ちにしてください。

以前のGitHub Actions

まだベータ版ですが、以下のページから登録して使える様にリクエストを出すことが出来ます。

Features • GitHub Actions

GitHub Actionsという物自体は昨年発表されベータ版で使える様になっていました。

ベータ版が使える様になると、レポジトリの上側のタブのPull requestsとProjectsの間に Actionsというタブが出来ます。

ここをクリックすると以前は以下のページに有るようなGUIな感じでワークフローを作っていく様なページに行きました。

GitHub Actions：みなさんが開発し、GitHubで実行 - The GitHub Blog - Japan

以下のページにあるような専用フォーマット?(main.workflow)で直接ワークフローを編集することも出来ました。

An open source parser for GitHub Actions - The GitHub Blog

一般的なCI/CDサービスだとYAML形式でワークフローを書いていくことが多いので書くのはちょっと面倒な感じ。どちらかというとGUIでやっていくことに頑張ってしまった感じでした。

こちらもlimited public beta (2019/10/16) だったので登録後しばらくしてから使える様になっていましたが、ちょっと使いづらい感じがしてちゃんと使っていませんでした。

新しいGitHub Actions

先日このGitHub Actionsの新しいバージョンが発表されました。

Updates to GitHub Actions (limited public beta) - The GitHub Blog

これも limited public beta (2019/08/08) です。

ただ、ベータ版の申込みとしては以前のGitHub Actionsと同じページからになるのでこれが発表されてから申し込んでみたところすでに申し込んであります、と出てました。

それでActionsというタブは出来てるのでてっきり新しいものが使える様になっていたと思ってましたが前のベータ版が使えていてもすぐに新しいものが使えるわけではなかったようです。

今日You’re in! Get started with GitHub Actions betaという題名のメールが来ていて見てみたらActionsの中身が新しくなっていました。

以前のベータ版は2018年10月に発表されてすぐ登録して2019年1月に Your GitHub Actions invite is Readyというメールが来て使える様になっていたようです。

ということで適当なレポジトリで見てみるとこんな感じで以前とは違いテンプレートを選べる様になっていて選ぶと.github/workflows/XXX.ymlというYAML形式のファイルを編集するページに飛ぶようになっています。

この.github/workflowsというディレクトリにYAMLファイルを置くとそれを元にActionを起こしてくれる仕組みです。 (名前は.yml拡張子なら何でも良い。)

これは他のCI/CDサービスでもよく見るような形で他のところで行っているCI/CDを移植するのも簡単そうです。

とりあえずやってみる

適当なレポジトリで Actionsに行くと一番上にレポジトリに基づいたワークフローのテンプレートが選べる様になっています。もしくは右上のSet up a workflow yourselfを選ぶとシンプルなテンプレートから作れます。

とりあえずこのテストレポジトリにはなにもないのでシンプルなテンプレートが表示されてたのでそれを使ってみます。

.github/workflows/blank.yml

name: CI

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v1
    - name: Run a one-line script
      run: echo Hello, world!
    - name: Run a multi-line script
      run: |
        echo Add other actions to build,
        echo test, and deploy your project.

onでどの様なタイミングで実行するかトリガーを指定します。ここではpushされたとき。

その後にjobs.buildとありますが、このbuildのところは<job_id>と呼ばれ、複数の<job_id>をjobsの中に指定することが出来ます。 buildというのはただのid名なのでjob1とかでもOK。

jobs.<job_id>.runs-onでは実行環境を選びます。ここではUbuntuが選ばれてます。

その後のjobs.<job_id>.stepsで実際に実行したいことを書いていきます。

最初に使っているusesでは外部レポジトリで定義されたアクションを実行することができます。 actionsレポジトリのcheckoutのv1のaction.yml の内容が実行されることになります。アクションを実行するディレクトリは最初何もない状態なので、大概の場合はまず最初に該当のレポジトリを持ってこないと始まりません。 actions/checkoutを呼ぶとカレントディレクトリに該当のレポジトリを持ってきます。カレントディレクトリの中にレポジトリを置く、のではなく、カレントディレクトリ自体がレポジトリのトップになるようなことをしてくれます。

各ステップごとにcdなどしても次のステップでは必ず GITHUB_WORKSPACE (Ubuntuだと /home/runner/work/<repository name>/<repository name> ) からスタートするので、その場でactions/checkoutをすることですべてのステップでレポジトリのトップから作業を行う様になります。

そのあと各実行項目としてname、runで実行コマンドごとの名前と内容を指定しています。

このままWeb上からcommit出来るのでしてみます。

しばらくするとActionsのタブの中が変わって実行結果が見れるようになります。

実行されたものを選択してみてみるとこんな実行内容が見れます。

実行中もここで経過を見ることも出来ます。

ここではWebインターフェースから作りましたが、直接**.github/workflows/.yml**を作ってcommitすることでも Actionsを定義することが出来ます。

また、以下のレポジトリにいろいろな言語様などのテンプレートがあります。

Features • GitHub Actions のページの下の方に行くと他の人が作った例を色々と見ることが出来ます。今はこの紹介ページでたくさんのレポジトリが流れる様な表示になっていますが、このうちactionsというユーザー名の名のもとにまとめられているものもあります。

GitHub Actions

また、Marketplaceにも例が色々とあります。

GitHub Marketplace · Actions to improve your workflow

ただここはまだ古いバージョン用のもの(YAML形式でないもの)も混じっているのでちょっと注意が必要です。

多分そのうちこれ以外にもまとめられたページが出来るかもしれません。 (先にサードパーティーで作られるかも。)

設定項目

トリガー

GitHubの直サービスなので他の連携サービスに比べかなり細かく色々とトリガーが選べます。

cronジョブの様に定期的に実行することも出来ます。

Events that trigger workflows - GitHub Help

ビルド環境

GitHub ActionsではLinux(Ubuntu)、macOS、Windowsの環境で実行することが出来ます。これらはMicrosoft Azure上の仮想環境ということで、 Microsoftによる買収が用方向に行ってる一つの例だと思います。

今現在使えるバージョンは以下から確認出来ます。

Virtual environments for GitHub Actions - GitHub Help

指定はjobs.<job_id>.runs-onというパラメーターに設定しますが、複数まとめて行いたい場合にはmatrixを使って

jobs:
  build:

    runs-on: ${{matrix.os}}
    strategy:
      matrix:
        os: [ubuntu-latest, macOS-latest, windows-latest]

の様に書くことが出来ます。このmatrixで複数を指定する方法はは他の項目にも使えます ¹ 。

暗号化

CI/CDを回したい時にどうしてもパスワードなどの秘密情報をどこかに書いておかないとやりたいことが出来ないことがあります。

GitHub Actionsでもその様な状況に対応していて、文字列を暗号化して入れておくことが出来るようになっています。

Creating and using secrets (encrypted variables): Virtual environments for GitHub Actions - GitHub Help

Settingsの中にActions用のSecretsという項目が出来ていてここで暗号化したい文字列を設定することができます。

また、CIでレポジトリにpushしたり何らか変更したりしたい場合がありますが、その場合GITHUB_TOKENを発行してそれを使う必要がありました。他のサービスを使う場合にはこれをGitHubで発行して、各サービスでこれを暗号化して登録して使います。

GitHub Actionsでは実行するレポジトリのGITHUB_TOKENは自分で発行しなくても$ で専用のトークンを使える様になっています。こういった事をよくしてる場合にはかなり工程が減るので便利だし、トークンが漏れる可能性も減るので良いと思います。

job_idごとの依存関係

jobs.<job_id>.needs を使うと他のjob_idの内容が成功したときだけ実行する様にできます。

その他設定項目

以下からActions用のYAMLでの設定項目が確認できます。

Workflow syntax for GitHub Actions - GitHub Help

実行制限

現在の実行制限は以下の様なものです²。

同時に実行できるワークフローはレポジトリ毎に20個まで。
実行できるAPIリクエストはレポジトリ毎に1時間で1000。
各ジョブの実行時間は最大6時間。
同時に走らせられるのはレポジトリ毎に20ジョブ。

と、かなり緩いものになっています。色々テストしてみましたが待たされる、といったことは今の所ありませんでした。

料金

パブリックレポジトリに関してはすべて無料です。

プライベートレポジトリに関しては無料では2000時間/月まで。 GitHubでProに入ってる人は3000時間/月まで。

あとは超えた分だけの従量課金せいで、各OSによって違います ³。

Linux (2cores, 7GB): $0.008/min
Windows (2cores, 7GB): $0.016/min
macOS (2cores, 7GB): $0.08/min

OS代?なのかわかりませんが、Linuxが一番安くなっています。そしてMicrosoftなので?macOSよりWindowsの方が圧倒的に安い。

2000分(33時間)追加で

Linux: $16
Windows: $32
macOS: $160

となります。

さらに今後Self-hostedで走らせることも出来るようになる様で、これを使うのであればPrivateでも制限なく無料で使えるようになるようです。

他CIサービスの状況

ちなみに、GitHubは昨年Microsoftに買収されましたが、 CIサービスとして、 wercker は一昨年にOracleに、Travis CIは今年はじめにIDeraに買収されています。ともにデータベース系の会社が買収している、と。

あとはDevOps環境に関するサービスを展開しているJFrogも今年はじめに Shippableを買収しています。

未だ独立なサービスでこれらに匹敵するものとしては CircleCIや Androidなどの環境などのためによく使われる Bitrise とかがあります。

あとはWindowsのGUIなどで使われる AppVeyor。以前はWindows用、という感じでしたが今はLinuxもサポートしているみたいです。

この辺のサービスはBitBucketなど他のGitホスティングサービスなどもサポートしてたりしますが、主なものはやはりGitHubのレポジトリになっていると思います。

ちょっとこれらのサービスをGoogle Trendsで見てみると

こんな感じで2016年位まではTravis CIが圧倒的だったのに対して、最近ではCircleCIが逆転しています。また、Bitriseが最近ではTravis CIに迫る勢いです。 AppVeyorは入ってませんが今現在はBitriseの半分くらいの検索ボリュームで Werckerとかよりは検索されています。

これだけ見ると中国とかでTravis CIが人気なようですが、ここ30日で見るとそうでもないので単にTravis CIが優勢だった頃に中国とかでよく検索されていた、ということみたいです。一方なぜか今も南半球ではTravis CIが人気a?

日本だけで見ると日本語のインターフェースが無いためかTravis CIがずっと苦戦しています。