GitHub Actions をローカル環境で実行したい（Self-hosted runners）

7047 ワード
Electron GitHubActions JavaScript Node.js JavaScript テキストリンク

Intro

2019年の GitHub Universe で GitHub Actions が正式リリースされました

GitHub Actions について詳しく知りたい方は 紹介ページ や 開発者向けドキュメント をご覧ください。

ソースコードと CI/CD 機能が同じサービス内で管理できるのは実に収まりがいいです
また Matrix Build といった強力な特徴があるため CircleCI 等の他社製サービスからの乗り換えを検討している方も多いのではないかと思います。

自分も試しに Electron のテスト（e2eを含む）と Mac 用、Windows 用のパッケージングを GitHub Actions で試したところ、（ほとんど）問題なく動作しそれぞれの OS 向けのパッケージを成果物として作成できました。
https://github.com/Kurom96/electron-boilerplate
楽です

ご存知の人もいるかと思いますが、Mac で Windows 用のパッケージを作成しようと思うと環境構築が割と面倒です。
空いてる Windows PC があったらそれ借りてパッケージ作った方が幸せになれます。

Self-hosted runners

GitHub Universe が開催された 11/13 から遡ること 8日、GitHub ブログに以下の記事が投稿されました。

英語力が乏しい私でもなんとなく理解できそうな長さの内容です…
GitHub Actions の実行環境を自分でホストすることができるようになりました！！
って書いてあるっぽいです

2ヶ月ほど前から GitHub Actions をさわってきましたが、GitHub上のVMだけに「こんなときはどうしようかな」と考えるシチュエーションがいくつかありました。
ローカルで実行できるなら、そのほとんどがこれで解決されてしまいそうな勢いです。

こんなときはどうしようかなリスト
1. 証明書等をリポジトリで管理したくない
2. ビルド環境が特殊で GitHub の VM に構築できない
3. リポジトリがプライベートで月毎の稼働時間をオーバーしてしまいそう

注意点

Public のリポジトリで Self-hosted runners を追加するのはとても危険です。
悪意ある Push で予期せぬ情報の取得や破壊行為が生じかねません。
お気をつけください

やってみる

https://github.com/Kurom96/electron-boilerplate
この Electron のリポジトリを例に説明します。
Actions のワークフローは構築済みです。

このリポジトリをコピー、または fork して Private リポジトリで作業しましょう。
リポジトリの Settings ページを開くと Actions のタブがあります。

以下、Actions permissions と Self-hosted runners の2つの項目があります。

Actions permissions は、その名の通り Actions の実行許諾なので今回は触りません。
一番上のが選択されているままでOKです。

ランナーを登録する

先程のSelfhosted runnerの項目内にあるAdd Runner ボタンを押下します。
ランナー追加の手順が書かれたダイアログが表示されます。
このとき、黄色い注意のメッセージが表示される場合 Public リポジトリです。

ここでは MacOS の場合の手順を紹介します。
ツールをダウンロードして展開します。

$ mkdir actions-runner && cd actions-runner
$ curl -O https://githubassets.azureedge.net/runners/2.160.2/actions-runner-osx-x64-2.160.2.tar.gz
$ tar xzf ./actions-runner-osx-x64-2.160.2.tar.gz

以下のコマンドは、先程のボタン押下後のページのダイアログに記載されているものです。
コマンド内の波括弧の部分はダイアログですでに置き換わって表示されているため、
画面からそのままコピペでいけます。
ランナーの名前とワークフォルダ名を問われるので適当に答えましょう。

$ ./config.sh --url https://github.com/{user}/{repo} --token {token}

準備ができたので実行します。

$ ./run.sh

√ Connected to GitHub

2019-11-15 08:27:05Z: Listening for Jobs

ランナーが待ち受け状態になりました。
GitHub のページで確認すると…

ランナーをワークフローに登録する

ワークフローファイル（.github/workflows/*.yml）内の runs-on を変更します。

runs-on: self-hosted

書き方がいくつかあるようで、例えば Windows と Mac の2つがホストされている場合、OSやアーキテクチャを指定することができるようです。
以下のように書けば MacOS のランナーを指定したことになります。

runs-on: [self-hosted, macos]

というか runs-on にはランナー名を指定できるようにしてほしいなぁ…

さ、コミットしてリポジトリにプッシュします。
このリポジトリではプッシュをトリガーにテストとパッケージビルドのジョブが順番に実行されます。

2019-11-15 04:50:10Z: Running job: test
2019-11-15 04:50:43Z: Job test completed with result: Succeeded
2019-11-15 04:50:49Z: Running job: build (self-hosted)
2019-11-15 04:52:08Z: Job build (self-hosted) completed with result: Succeeded

無事実行できました。
Actionsタブのワークフローに成果物が登録されています。

所感

正直言うと Self-hosted runners は使わない方がいいです。

これ使っちゃうと結局用意された環境に依存してしまうからです。
Jenkinsおじさんに近しい役割の方がまた誕生します。

ただ、困った時の逃げ道として、これがあることは大きいです。
もし GitHub Actions 使ってて VM の壁にぶつかったらお試しください。

参考