変数

変数について

変数を使用して、ワークフローで参照する情報を格納できます。 ワークフロー ステップまたはアクション内で変数を参照すると、ワークフローを実行するランナー マシンで変数が補間されます。 アクションまたはワークフロー ステップ内で実行されるコマンドで、変数の作成、読み取り、変更ができます。

独自のカスタム変数を設定したり、GitHub が自動的に設定する既定の変数を使用したり、ランナーの作業環境で設定される他の環境変数を使用したりできます。 変数は大文字と小文字が区別されます。

に対する環境変数の定義

に対してカスタム環境変数を設定する場合、ワークフロー ファイルの env キーを使用して定義できます。 このメソッドで設定されるカスタム変数のスコープは、定義されている要素に制限されます。 次のスコープを設定する変数を定義できます。

• ワークフロー全体 (ワークフロー ファイルの最上位レベルで env を使用)。
• ワークフロー内のジョブの内容 (jobs.<job_id>.env を使用)。
• ジョブ内の特定の手順 (jobs.<job_id>.steps[*].env を使用)。

name: Greeting on variable day

on:
  workflow_dispatch

env:
  DAY_OF_WEEK: Monday

jobs:
  greeting_job:
    runs-on: ubuntu-latest
    env:
      Greeting: Hello
    steps:
      - name: "Say Hello Mona it's Monday"
        run: echo "$Greeting $First_Name. Today is $DAY_OF_WEEK!"
        env:
          First_Name: Mona

name: Greeting on variable day

on:
  workflow_dispatch

env:
  DAY_OF_WEEK: Monday

jobs:
  greeting_job:
    runs-on: ubuntu-latest
    env:
      Greeting: Hello
    steps:
      - name: "Say Hello Mona it's Monday"
        run: echo "$Greeting $First_Name. Today is $DAY_OF_WEEK!"
        env:
          First_Name: Mona

env 変数の値には、ランナー環境変数またはコンテキストを使用してアクセスできます。 上の例は、echo コマンド ($DAY_OF_WEEK、$Greeting、$First_Name) でランナー環境変数として使用されている 3 つのカスタム変数を示しています。 これらの変数の値は、それぞれワークフロー、ジョブ、ステップ レベルで設定され、スコープも設定されます。 これらの変数の補間はランナーで行われます。

ワークフローの run ステップまたは参照されるアクションのコマンドは、ランナーで使用しているシェルによって処理されます。 ワークフローの一部は GitHub Actions によって処理され、ランナーには送信されません。 run ステップでは、ランナー環境変数またはコンテキストのいずれかを使用できますが、ランナーに送信されないワークフローの部分では、変数値にアクセスするためにコンテキストを使用する必要があります。 詳しくは、「構成変数の値へのアクセスにコンテキストを使用する」を参照してください。

ランナー環境変数の補間は、ワークフロー ジョブがランナー マシンに送信された後に行われるため、ランナーで使用されるシェルに適切な構文を使用する必要があります。 この例では、ワークフローは ubuntu-latest を指定します。 既定では、Linux ランナーは Bash シェルを使用するため、構文 $NAME を使用する必要があります。 既定では、Windows ランナーは PowerShell を使用するため、構文 $env:NAME を使用します。 シェルの詳細については、「ギットハブ　アクション　のワークフロー構文」を参照してください。

環境変数の命名規則

環境変数を設定する場合、既定の環境変数名は使用できません。 既定の環境変数の完全な一覧については、以下の「既定の環境変数」を参照してください。 これらの既定の変数のいずれかの値をオーバーライドしようとすると、割り当ては無視されます。

ファイルシステム上の場所を指すように設定した新しい変数がある場合は、_PATH サフィックスを指定する必要があります。 既定の変数 GITHUB_ENV と GITHUB_WORKSPACE は、この規則の例外です。

コンテキストを使用した変数の値へのアクセス

コンテキストは、ワークフローの実行、変数、ランナーの環境、ジョブ、ステップに関する情報にアクセスする方法です。詳細については、「コンテキスト」を参照してください。 ワークフローには、さまざまな目的で使用できる他の多くのコンテキストがあります。 ワークフロー内で特定のコンテキストを使用できる場所の詳細については、「コンテキスト」を参照してください。

環境変数の値には、env コンテキストを使用して、アクセスできます。

env コンテキストを使用した環境変数の値へのアクセス

GitHub Actions では、ランナー環境変数に加えて、コンテキストを使用した env キー値の設定および読み取りを行うことができます。 環境変数やコンテキストは、ワークフロー中の様々な場所で利用できます。

ワークフローまたは参照先アクションの run ステップは、ランナーによって処理されます。 その結果、ランナーで使用するシェル (Linux ランナーの bash シェル用の $NAME や Windows ランナーの PowerShell用の $env:NAME など) に適した構文を使用して、ランナー環境変数をここで使用できます。 ほとんどの場合、コンテキストと構文 ${{ CONTEXT.PROPERTY }} を使用して、同じ値にアクセスすることもできます。 違いは、ジョブがランナーに送信される前にコンテキストが補間され、文字列に置き換えられるということです。

ただし、GitHub Actions によって処理され、ランナーには送信されないワークフローの一部のランナー環境変数値は使用できません。 その代わりに、コンテキストを使用することができます。 たとえば、ジョブまたはステップがランナーに送信されるかどうかを決定する if 条件は、常に GitHub Actions によって処理されます。 if 条件付きステートメントでコンテキストを使用して、変数の値にアクセスする必要があります。

env:
  DAY_OF_WEEK: Monday

jobs:
  greeting_job:
    runs-on: ubuntu-latest
    env:
      Greeting: Hello
    steps:
      - name: "Say Hello Mona it's Monday"
        if: ${{ env.DAY_OF_WEEK == 'Monday' }}
        run: echo "$Greeting $First_Name. Today is $DAY_OF_WEEK!"
        env:
          First_Name: Mona

env:
  DAY_OF_WEEK: Monday

jobs:
  greeting_job:
    runs-on: ubuntu-latest
    env:
      Greeting: Hello
    steps:
      - name: "Say Hello Mona it's Monday"
        if: ${{ env.DAY_OF_WEEK == 'Monday' }}
        run: echo "$Greeting $First_Name. Today is $DAY_OF_WEEK!"
        env:
          First_Name: Mona

前の例のこの変更では、if 条件を導入しました。 ワークフロー ステップは、DAY_OF_WEEK が "Monday" に設定されている場合にのみ実行されます。 env コンテキストを使用して、if 条件付きステートメントからこの値にアクセスします。 run コマンド内で参照される変数には、 env コンテキストは必要ありません。 これらはランナー環境変数として参照され、ランナーがジョブを受信した後に補間されます。 ただし、コンテキストを使用して、ランナーにジョブを送信する前に、これらの変数を補間することを選択できました。 結果の出力は同じになります。

run: echo "${{ env.Greeting }} ${{ env.First_Name }}. Today is ${{ env.DAY_OF_WEEK }}!"

ジョブがランナーに送信される前に処理されるワークフローの一部で、変数の値にアクセスするには、通常 env または github コンテキストを使用します。

既定の環境変数

GitHub が設定する既定の環境変数は、ワークフローのどのステップでも使用できます。

既定の環境変数は GitHub によって設定され、ワークフローで定義されていないため、env コンテキストを介してアクセスすることはできません。 しかし、既定の変数のほとんどは、対応する、似た名前のコンテキスト プロパティを持ちます。 たとえば、${{ github.ref }} コンテキスト プロパティを使用してワークフロー処理中に GITHUB_REF 変数の値を読み取ることができます。

GITHUB_* および RUNNER_* という名前の既定の環境変数の値を上書きすることはできません。 現時点では、CI 変数の値を上書きできます。 ただし、これが常に可能になることは保証されていません。 環境変数の設定の詳細については、「1 つのワークフローの環境変数の定義」および「GitHub Actions のワークフロー コマンド」を参照してください。

アクションでは、ファイルシステムにアクセスするとき、ハードコードされたファイル パスを使うのではなく変数を使用することを強くお勧めします。 GitHub は、すべてのランナー環境でアクションが使用する変数を設定します。

オペレーティング システムの検出

既定の環境変数 RUNNER_OS と対応するコンテキスト プロパティ ${{ runner.os }} を使用して、異なるオペレーティング システムに使用できる 1 つのワークフロー ファイルを記述できます。 たとえば、ランナーによって使用されるシェルに応じて異なる、環境変数の構文を変更しなくても、オペレーティング システムを macos-latest から windows-latest に変更した場合、次のワークフローを正常に実行できます。

jobs:
  if-Windows-else:
    runs-on: macos-latest
    steps:
      - name: condition 1
        if: runner.os == 'Windows'
        run: echo "The operating system on the runner is $env:RUNNER_OS."
      - name: condition 2
        if: runner.os != 'Windows'
        run: echo "The operating system on the runner is not Windows, it's $RUNNER_OS."

jobs:
  if-Windows-else:
    runs-on: macos-latest
    steps:
      - name: condition 1
        if: runner.os == 'Windows'
        run: echo "The operating system on the runner is $env:RUNNER_OS."
      - name: condition 2
        if: runner.os != 'Windows'
        run: echo "The operating system on the runner is not Windows, it's $RUNNER_OS."

この例では、2 つの if ステートメントによって runner コンテキストの os プロパティがチェックされ、ランナーのオペレーティング システムが決定されます。 if 条件は GitHub Actions によって処理され、チェックによって true として解決されるステップのみ、ランナーに送信されます。 ここでは、チェックの 1 つが常に true となり、もう 1 つが false になるため、これらのステップの 1 つだけがランナーに送信されます。 ジョブがランナーに送信されると、ステップが実行され、echo コマンド内の環境変数が適切な構文を使用して補間されます (Windows の PowerShell の場合 $env:NAME、Linux および MacOS の bash と sh の場合 $NAME)。 この例では、ステートメント runs-on: macos-latest では 2 番目のステップが実行されます。

ワークフロー内のステップとジョブの間で値を渡す

ジョブの 1 つのステップで値を生成する場合は、既存または新しい環境変数に値を割り当て、これを GITHUB_ENV 環境ファイルに書き込むことで、同じジョブの後続のステップで値を使用できます。 環境ファイルは、アクションによって直接使用することも、run キーワードを使用してワークフロー ファイル内のシェル コマンドから使用することもできます。 詳しくは、「GitHub Actions のワークフロー コマンド」を参照してください。

ワークフロー内のあるジョブのステップから、そのワークフロー内の別のジョブのステップに値を渡す場合は、その値をジョブ出力として定義できます。 その後、別のジョブのステップからこのジョブ出力を参照できます。 詳しくは、「ギットハブ　アクション　のワークフロー構文」を参照してください。