GitHub Actionsの実行方法
このセクションでは、GitHub Actionsを実行する方法となる「トリガー」や、実行環境である「ランナー」について説明します。
1. トリガー(Trigger)
トリガーは、GitHub Actionsにおいてワークフローの実行を開始するきっかけとなるイベントのことです。GitHub ActionsではGitHubの各種操作に応じてさまざまなトリガーが用意されています。
1.1 トリガーの種類
代表的なトリガーには次のようなものがあります。
| トリガー | 説明 | 主な利用シーン |
|---|---|---|
push |
ブランチにコードがプッシュされたときに実行 | ビルドやデプロイなど、反映処理の自動化 |
pull_request |
プルリクエストが作成または更新されたときに実行 | レビュー前の静的解析や自動テスト |
schedule |
cron形式で指定した時刻に定期実行 |
毎週日曜日の午前1時に自動実行するなど |
workflow_dispatch |
手動でワークフローを実行 | 特定のタイミングで自動テストだけを実行したい場合など |
このほかにも、GitHub Issueの更新やリリースの公開など、さまざまなイベントをトリガーとして設定することができます。
1.2 トリガーのコード例
これらをYAMLファイルのon:セクションで指定します。例えば、次のように記述します。
on:
workflow_dispatch:
この例では、workflow_dispatchを指定しているため、手動での実行を行います。
このように、トリガーを設定することで、開発の各段階(コード更新・レビュー・リリースなど)に応じて、自動的にビルドやテスト、デプロイを実行する仕組みを作ることができます。
2. ランナー(Runner)
2.1 ランナーとは
ランナーとは、ジョブを実際に実行するための環境のことを指します。ワークフローで定義した処理は、このランナーで指定した環境上で動作します。
例えば、Linux(Ubuntu)、Windows、macOSなどのOS環境をGitHub Actionsの実行環境として指定し、ワークフローを実行できます。ここでのlatestとは「最新版」を意味します。
Ubuntuをランナーとして指定した場合、GitHubがUbuntu環境を自動的に用意し、その中でワークフローを実行します。
なお、ステップのrunで実行するコマンドは、ランナーの環境(OS)に依存します。そのため、Ubuntu環境で利用できるコマンドやディレクトリ構成を使ったり、アプリケーションをインストールすることも可能です。
2.2 ランナーのコード例
ランナーは、runs-onと記載したあと、ランナーの種類を指定することで記載できます。
runs-on: ubuntu-latest
ここではubuntu-latestを指定しているため、このジョブで定義された処理はUbuntu環境上で実行されます。
2.3 ランナーの種類
GitHub Actionsのランナーには、ホステッドランナーとセルフホステッドランナーの2種類があります。
ホステッドランナーはGitHubが公式に提供している実行環境で、ユーザが自分でサーバを用意する必要はありません。
代表的なものに、Ubuntu環境のubuntu-latest、Windows環境のwindows-latest、macOS環境のmacos-latestがあります。
特別な設定をしなくても、これらの環境を指定するだけでジョブを実行できます。
セルフホステッドランナーは、自分で管理しているサーバやクラウド環境上にランナーを用意し、その上でGitHub Actionsの処理を実行する方法です。 この方法では、より細かい環境制御が可能で、専用ネットワークや独自構成など、特殊な要件にも対応できます。 特に、大規模なプロジェクトやセキュリティ要件が厳しいシステムでは、外部のホステッド環境を利用できない場合があります。そうしたケースで、セルフホステッドランナーが有効です。
3. アクション(Action)
3.1 アクションとは
アクションとは、GitHub Actionsのステップで実行される、再利用可能な処理の定義です。ワークフローの中で行いたい処理を、あらかじめまとめて提供してくれているパーツのようなイメージです。自分で一から処理を書かなくても、必要な機能を簡単に利用できるという点が大きなメリットです。
アクションには、非常に多くの種類があります。例えば、以下のようなものが代表例としてよく利用されます。
actions/checkout- リポジトリ内のコードをチェックアウトするアクションです。actions/setup-python- Pythonの実行環境をセットアップします。docker/build-push-action- Dockerイメージをビルドし、レジストリにプッシュします。aws-actions/configure-aws-credentials- GitHub ActionsからAWSにログインできるようにするためのアクションです。slackapi/slack-github-action- Slackへ通知を送るためのアクションです。
このように、よく使う処理はすでにアクションとして提供されています。
3.2 アクションのコード例
ワークフロー内では、アクションをuses:という記述を使って呼び出します。uses:の右側に、利用したいアクション名を指定します。
- uses: docker/build-push-action@v6
with:
push: true
tags: user/app:latest
@v6は、利用するアクションのバージョンを指定している部分です。ここでのv6は、アクションそのもののリリースバージョン(メジャーバージョン)を指しています。バージョンを明示しておくことで、予期せぬアップデートによる動作変更を避け、ワークフローの再現性を保つことができます。
利用できるバージョンや、そのアクションを誰が提供しているか(公式アクションかどうか)は、GitHub Marketplace(https://github.com/marketplace)で該当アクションを検索するか、アクションのリポジトリ(例: docker/build-push-actionならhttps://github.com/docker/build-push-action)のReleasesタブで確認できます。Marketplace上で「Verified creator」と表示されているものは、GitHubが提供元組織を認証済みのアクションです。
続いてwith:ブロックでは、アクションに渡すパラメータを設定します。この例ではpush: trueとすることで、Dockerイメージのプッシュを行うことを指定しており、tags: user/app:latestで付与するタグを指定しています。
なお、pushはデフォルトがfalseとなっており、書かなかった場合はイメージのビルドだけ行いレジストリへのプッシュはスキップされます。プルリクエスト時にビルドが通るかどうかだけを検証したいワークフローではデフォルトのままにしておき、mainブランチへのマージなど「レジストリに反映したい」段階でtrueを指定するといった使い分けをします。
3.3 アクションの種類
アクションの種類について説明します。
GitHub Actionsで利用できるアクションには、大きく分けて3つの種類があります。それぞれの特徴を理解しておくと、ワークフローを設計する際に、どのアクションを使うべきか判断しやすくなります。
まず1つ目は公式アクションです。これは、GitHubが公式に提供しているアクションになります。リポジトリのチェックアウト(actions/checkout)やプログラミング言語環境のセットアップ(actions/setup-pythonなど)といった、GitHub上でよく利用される基本的な処理が定義されています。信頼性が高く、メンテナンスも継続的に行われているため、特に初心者の方はまず公式アクションを利用することをおすすめします。
2つ目はコミュニティアクションです。こちらはGitHubのユーザや組織が公開しているアクションで、公式アクションでは提供されていない機能を補う際に役立ちます。例えば、AWSの認証処理(aws-actions/configure-aws-credentials)やDockerイメージのビルド(docker/build-push-action)など、各サービスの提供元が公開しているアクションもこのカテゴリに含まれます。
GitHub Marketplaceから検索して利用することができます。多くのニーズに応えられる反面、品質や更新状態は提供者によって異なるため、利用する際はスター数や最終更新日などを確認することが大切です。
そして3つ目はカスタムアクションです。自分で独自に作成するアクションのことです。 プロジェクトや組織独自の処理を共通化したい場合に非常に有効で、Shell ScriptやDocker、JavaScriptなどを利用して作成できます。共通機能としてアクション化しておけば、複数のワークフローで再利用しやすくなり、メンテナンス性も向上します。