複雑なワークフローを管理する

このガイドでは、シークレット管理、依存ジョブ、キャッシング、ビルドマトリックス、環境、ラベルなど、GitHub Actions の高度な機能を使用する方法を説明します。

ここには以下の内容があります:

概要
シークレットを保存する
依存ジョブを作成する
ビルドマトリックスを使用する
依存関係のキャッシング
データベースとサービスコンテナの利用
ラベルを使用してワークフローを転送する
環境の使用
ワークフローテンプレートの使用
次のステップ

概要

この記事では、より複雑なワークフローの作成に役立つ GitHub Actions の高度な機能の一部について説明します。

シークレットを保存する

ワークフローでパスワードや証明書などの機密データを使用する場合は、これらを GitHub に secrets として保存すると、ワークフローで環境変数として使用できます。これは、YAML ワークフローに直接機密値を埋め込むことなく、ワークフローを作成して共有できることを示しています。

この例では、既存のシークレットを環境変数として参照し、それをパラメータとしてサンプルコマンドに送信する方法を示しています。

jobs:
  example-job:
    runs-on: ubuntu-latest
    steps:
      - name: Retrieve secret
        env:
          super_secret: ${{ secrets.SUPERSECRET }}
        run: |
          example-command "$super_secret"

詳しい情報については「暗号化されたシークレットの作成と保存」を参照してください。

依存ジョブを作成する

デフォルトでは、ワークフロー内のジョブはすべて同時並行で実行されます。したがって、別のジョブが完了した後にのみ実行する必要があるジョブがある場合は、needs キーワードを使用してこの依存関係を作成できます。ジョブのうちの 1 つが失敗すると、依存するすべてのジョブがスキップされます。ただし、ジョブを続行する必要がある場合は、if 条件ステートメントを使用してこれを定義できます。

この例では、setup、build、および test ジョブが連続して実行され、build と test は、それらに先行するジョブが正常に完了したかどうかに依存します。

jobs:
  setup:
    runs-on: ubuntu-latest
    steps:
      - run: ./setup_server.sh
  build:
    needs: setup
    runs-on: ubuntu-latest
    steps:
      - run: ./build_server.sh
  test:
    needs: build
    runs-on: ubuntu-latest
    steps:
      - run: ./test_server.sh

詳しい情報については、jobs.<job_id>.needs を参照してください。

ビルドマトリックスを使用する

ワークフローでオペレーティングシステム、プラットフォーム、および言語の複数の組み合わせにわたってテストを実行する場合は、ビルドマトリックスを使用できます。ビルドマトリックスは、ビルドオプションを配列として受け取る strategy キーワードを使用して作成されます。たとえば、このビルドマトリックスは、異なるバージョンの Node.js を使用して、ジョブを複数回実行します。

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node: [6, 8, 10]
    steps:
      - uses: actions/setup-node@v1
        with:
          node-version: ${{ matrix.node }}

詳しい情報については、jobs.<job_id>.strategy.matrix を参照してください。

依存関係のキャッシング

GitHub ホストランナーは各ジョブの新しい環境として開始されるため、ジョブが依存関係を定期的に再利用する場合は、これらのファイルをキャッシュしてパフォーマンスを向上させることを検討できます。キャッシュが作成されると、同じリポジトリ内のすべてのワークフローで使用できるようになります。

この例は、~/.npm ディレクトリをキャッシュする方法を示しています。

jobs:
  example-job:
    steps:
      - name: Cache node modules
        uses: actions/cache@v2
        env:
          cache-name: cache-node-modules
        with:
          path: ~/.npm
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-build-${{ env.cache-name }}-

詳しい情報については、「ワークフローを高速化するための依存関係のキャッシュ」を参照してください。

データベースとサービスコンテナの利用

ジョブにデータベースまたはキャッシュサービスが必要な場合は、services キーワードを使用して、サービスをホストするための一時コンテナを作成できます。そして、作成されたコンテナはそのジョブ内のすべてのステップで利用でき、ジョブが完了すると削除されます。この例は、ジョブが services を使用して postgres コンテナを作成し、node を使用してサービスに接続する方法を示しています。

jobs:
  container-job:
    runs-on: ubuntu-latest
    container: node:10.18-jessie
    services:
      postgres:
        image: postgres
    steps:
      - name: Check out repository code
        uses: actions/checkout@v2
      - name: Install dependencies
        run: npm ci
      - name: Connect to PostgreSQL
        run: node client.js
        env:
          POSTGRES_HOST: postgres
          POSTGRES_PORT: 5432

詳しい情報については、「データベースおよびサービスコンテナを使用する」を参照してください。

ラベルを使用してワークフローを転送する

この機能は、特定のセルフホストランナーにジョブを割り当てるのに役立ちます。特定のタイプのランナーがジョブを処理するようにしたい場合は、ラベルを使用してジョブの実行場所を制御できます。セルフホストランナーにラベルを割り当ててから、YAML ワークフローでこれらのラベルを参照して、ジョブが予測可能な方法で転送されるようにすることができます。

この例は、ワークフローがラベルを使用して必要なランナーを指定する方法を示しています。

jobs:
  example-job:
    runs-on: [self-hosted, linux, x64, gpu]

詳しい情報については、「セルフホストランナーでのラベルの利用」を参照してください。

環境の使用

保護のルールとシークレットを持つ環境を設定できます。ワークフロー内の各ジョブは、1つの環境を参照できます。この環境を参照するとジョブがランナーに送信される前に、環境に設定された保護ルールをパスしなければなりません。詳しい情報については「環境」を参照してください。

ワークフローテンプレートの使用

GitHub provides preconfigured workflow templates that you can customize to create your own continuous integration workflow. GitHub analyzes your code and shows you CI templates that might be useful for your repository. たとえばリポジトリにNode.jsのコードが含まれているなら、Node.jsプロジェクトのためのサジェッションが提示されます。ワークフローテンプレートは、カスタムワークフローの構築の出発点として利用することも、そのまま利用することもできます。

actions/starter-workflows リポジトリ。