YAML設定リファレンス

name: string                  # 必須: ワークフロー名
description: string           # 任意: ワークフローの説明
vars:                         # 任意: ワークフロー変数
  key: value
secrets:                      # 任意: 出力で伏せる環境変数
  - NAME
jobs:                         # 必須: ジョブのリスト
  - name: string              # 必須: ジョブ名
    id: string                # 任意: ジョブ ID。needs から参照する
    needs: [job-id, ...]      # 任意: 依存するジョブ
    skipif: expression        # 任意: 真ならジョブをスキップ
    defaults:                 # 任意: アクションごとの with の既定値
      http:
        url: string
    repeat:                   # 任意: ジョブを繰り返す
      count: integer
      interval: duration
    steps:                    # 必須: ステップのリスト
      - name: string          # 任意: ステップ名
        id: string            # 任意: ステップ ID。outputs の公開に必要
        uses: string          # 必須: アクション名
        with:                 # 任意: アクション引数
          key: value
        test: expression      # 任意: アサーション
        echo: string          # 任意: レポートに出力する文字列
        vars:                 # 任意: ステップ変数
          key: value
        outputs:              # 任意: 後続へ渡す値
          key: expression
        skipif: expression    # 任意: 真ならステップをスキップ
        wait: duration        # 任意: 実行前の待機
        timeout: duration     # 任意: ステップのタイムアウト
        iteration:            # 任意: 要素ごとにステップを繰り返す
          - key: value
        retry:                # 任意: 失敗時のリトライ
          max_attempts: integer
          interval: duration
          initial_delay: duration

name: "API Health Check"

description: |
  本番 API を確認します。
  - エンドポイントの死活
  - レスポンスタイム

vars:
  # 環境変数を読む
  api_url: "{{API_URL}}"
 
  # デフォルト付き
  timeout: "{{REQUEST_TIMEOUT ?? '30s'}}"
 
  # 読み込み時に計算する
  run_id: "{{random_str(8)}}"
 
  # ネストした値も書ける
  auth:
    user: "{{API_USER}}"

vars:
  http_port: "{{HTTP_PORT ?? '18080'}}"
  base: "http://localhost:{{vars.http_port}}"
  password: "{{PASSWORD ?? random_str(24)}}"
  basic_auth: "Basic {{encode_base64('alice:' + vars.password)}}"

secrets:
  - API_TOKEN
  - DB_PASSWORD
vars:
  api_token: "{{API_TOKEN}}"
  db_password: "{{DB_PASSWORD}}"

jobs:
  - id: setup
    name: Setup
    steps:
      - name: Prepare
        uses: hello
        echo: "ready"
 
  - name: Test
    needs: [setup]
    steps:
      - name: Run
        uses: hello
        echo: "testing"

jobs:
  - name: Production only
    skipif: vars.environment != "production"
    steps:
      - name: Check
        uses: http
        with:
          url: "{{vars.api_url}}/health"
          method: GET

jobs:
  - name: API checks
    defaults:
      http:
        url: "{{vars.api_url}}"
        headers:
          authorization: "Bearer {{vars.token}}"
          accept: application/json
    steps:
      - name: Health
        uses: http
        with:
          get: /health        # 既定の url からの相対パス
        test: res.code == 200

      - name: Explicit method
        uses: http
        with:
          url: "{{vars.api_url}}/health"
          method: GET

jobs:
  - name: Poll until ready
    repeat:
      count: 10
      interval: 5s
    steps:
      - name: Check
        uses: http
        with:
          url: "{{vars.api_url}}/status"
          method: GET
        test: res.code == 200

steps:
  - name: Log in
    id: auth
    uses: http
    with:
      url: "{{vars.api_url}}/login"
      method: POST
    test: res.code == 200
    outputs:
      token: res.body.access_token
      user_id: res.body.user.id

      headers:
        Authorization: "Bearer {{outputs.auth.token}}"
        X-User: "{{outputs.user_id}}"

    echo: "{{outputs['create-user'].user_id}}"

steps:
  - name: Flaky endpoint
    uses: http
    with:
      url: "{{vars.api_url}}/slow"
      method: GET
    test: res.code == 200
    retry:
      max_attempts: 3
      interval: 2s

steps:
  - name: Check {{vars.path}}
    uses: http
    iteration:
      - path: /health
      - path: /metrics
      - path: /version
    with:
      url: "{{vars.api_url}}{{vars.path}}"
      method: GET
    test: res.code == 200

    test: |
      res.code == 200 &&
      res.headers["Content-Type"] contains "application/json" &&
      res.body.status == "ok" &&
      rt.sec < 1

timeout: "30s"
timeout: "5m"
interval: 10        # 10 秒

url: "{{vars.api_url}}/users/{{outputs.auth.user_id}}"

test: res.code == 200 && rt.sec < 2
skipif: vars.environment == "local"

# 先行するステップが outputs.login を出力していなければ、ステップは失敗する
headers:
  authorization: "Bearer {{outputs.login.token}}"
 
# 代わりの値を使う
headers:
  authorization: "Bearer {{outputs.login?.token ?? 'none'}}"

probe base.yml,production.yml