GitHub Actionsの構成要素

このセクションでは、GitHub Actionsにおけるいくつかの構成要素を説明します。

1. ワークフロー(Workflow)

GitHub Actionsの処理はワークフローという単位で定義され、その中がジョブとステップに細分化されます。

ワークフローとは、GitHub Actionsで自動的に実行される一連の処理の流れを定義したものです。 たとえば、コードがGitHubにプッシュされたときに「ビルド → デプロイ」といった処理を自動で実行するよう設定します。この全体のフローを「ワークフロー」と呼びます。

ワークフローには、どのイベントで処理を開始するか(例:push、pull_request)、どの環境で実行するか(例:ubuntu-latest)、どんな処理を行うか(例:テストやデプロイ)といった情報を記述します。これらの記載については後ほど詳しく説明します。

1.1 ワークフローのコード例

ワークフローのコード例を見てみましょう。細かい部分は後ほど説明しますが、ここではnameの部分に注目してください。

name: Test Workflow

nameにはワークフローの名前を指定します。ここでは「Test Workflow」という名前を付けています。この下に、トリガーや実行する処理を順に記載していきます。

1.2 ワークフローの画面表示

こちらが実際のGitHubにて、ワークフローを表示させた画面です。今回は「Test Workflow」という名前のワークフローを作成しており、左側の一覧にそれが表示されています。複数のワークフローを作成すれば、ここに追加されていきます。

中央の部分にはワークフローの実行履歴が表示されます。ここから、実行のステータスや結果を参照することができます。

実際のワークフローの作成方法や実行方法は、この後説明します。

2. ジョブ(Job)

2.1 ジョブとは

ワークフローはジョブとステップによって構成されます。ジョブは、ワークフロー内で実行される処理のまとまりを表します。

たとえば「ビルド」「デプロイ」という2つの処理を行う場合、それぞれを1つのジョブとして定義します。

ジョブごとに実行結果を確認したり、失敗したジョブのみを再実行したりできるため、柔軟な運用が可能です。

2.2 ジョブのコード例

ジョブのコード例を見てみましょう。

jobs:
  hello:

jobs:の下に、ジョブの名前を指定して定義します。ここではhelloという名前のジョブを定義しています。ジョブは複数指定することもできます。

2.3 ジョブの画面表示

これがGitHub Actionsの実行結果の画面ですが、ジョブごとに実行結果が表示される様になっています。

3. ステップ(Step)

3.1 ステップとは

ステップは、ジョブの中で順に実行される具体的な処理(コマンドやアクション)を記述する部分です。 実際に何を行うかを定義する箇所であり、スクリプトの実行や外部アクションの呼び出しなどを指定します。

3.2 ステップのコード例

jobs:
  hello:
    runs-on: ubuntu-latest
    steps:
      - name: メッセージを表示
        run: echo "Hello, GitHub Actions!"

このコードにあるsteps:と記載のある部分が、実際のステップを記載する箇所です。このコードでは、ステップに「メッセージを表示」という名前をつけています。

なお、コード上のruns-on: ubuntu-latestはこのジョブを実行する環境(ランナー)を指定する部分ですが、詳しくは後述の「ランナー」のセクションで説明します。

runは、ステップの中でシェルコマンドを実行するための命令です。run:の後ろに記載したコマンドが実行されます。実行できるコマンドは、この後説明する「ランナー」と呼ばれる実行環境によって異なります。今回使用しているランナーはubuntu(Linux)で動作するため、Linux系のコマンドが実行できます。

ここではecho "Hello, GitHub Actions!"という命令で、"Hello, GitHub Actions!"という文字列をコンソール上に出力しています。echoはLinuxにおいて、指定した文字列をコンソールやログに出力するコマンドです。

3.3 実行結果の例

この画面は、ワークフローの実行結果を表示した画面です。ステップのnameで指定した「メッセージを表示」が、実行結果として表示されています。

「メッセージを表示」を展開すると、echoコマンドで表示した「Hello, GitHub Actions!」のメッセージが表示されます。