{"meta":{"title":"変数に情報を格納する","intro":"GitHub は GitHub Actions ワークフロー実行ごとに、既定の変数を設定します。単一のワークフローまたは複数のワークフローで使用するカスタム変数を設定することもできます。","product":"GitHub Actions","breadcrumbs":[{"href":"/ja/actions","title":"GitHub Actions"},{"href":"/ja/actions/how-tos","title":"方法"},{"href":"/ja/actions/how-tos/write-workflows","title":"ワークフローを書き込む"},{"href":"/ja/actions/how-tos/write-workflows/choose-what-workflows-do","title":"ワークフロー動作を選択する"},{"href":"/ja/actions/how-tos/write-workflows/choose-what-workflows-do/use-variables","title":"変数の使用"}],"documentType":"article"},"body":"# 変数に情報を格納する\n\nGitHub は GitHub Actions ワークフロー実行ごとに、既定の変数を設定します。単一のワークフローまたは複数のワークフローで使用するカスタム変数を設定することもできます。\n\n## 単一のワークフローの環境変数の定義\n\n単一のワークフローにカスタム環境変数を設定するには、ワークフローファイル内の `env` キーを使用して環境変数を定義できます。このメソッドで設定されるカスタム変数のスコープは、定義されている要素に制限されます。次のスコープを設定する変数を定義できます。\n\n* ワークフロー全体 (ワークフローファイルの最上位レベルで [`env`](/ja/actions/using-workflows/workflow-syntax-for-github-actions#env) を使用)。\n* ワークフロー内のジョブの内容 ([`jobs..env`](/ja/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idenv) を使用)。\n* ジョブ内の特定の手順 ([`jobs..steps[*].env`](/ja/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsenv) を使用)。\n\n```yaml copy\nname: Greeting on variable day\n\non:\n workflow_dispatch\n\nenv:\n DAY_OF_WEEK: Monday\n\njobs:\n greeting_job:\n runs-on: ubuntu-latest\n env:\n Greeting: Hello\n steps:\n - name: \"Say Hello Mona it's Monday\"\n run: echo \"$Greeting $First_Name. Today is $DAY_OF_WEEK!\"\n env:\n First_Name: Mona\n```\n\n```\n `env` 変数の値には、ランナー環境変数またはコンテキストを使用してアクセスできます。上の例は、`echo` コマンドにおいて、ランナー環境変数として使用されている 3 つのカスタム変数 (`$DAY_OF_WEEK`、`$Greeting`、`$First_Name`) を示しています。これらの変数の値は、それぞれワークフロー、ジョブ、ステップレベルで設定され、スコープも設定されます。これらの変数の補間はランナー上で行われます。\n```\n\nワークフローの `run` ステップまたは参照されるアクションのコマンドは、ランナーで使用しているシェルによって処理されます。ワークフローの他の部分にある指示は GitHub Actions によって処理され、ランナーには送信されません。\n`run` ステップでは、ランナー環境変数またはコンテキストのいずれかを使用できますが、ランナーに送信されないワークフローの部分では、変数値にアクセスするためにコンテキストを使用する必要があります。詳しくは、「[コンテキストを使用した変数の値へのアクセス](#using-contexts-to-access-variable-values)」をご覧ください。\n\nランナー環境変数の補間は、ワークフロージョブがランナーマシンに送信された後に行われるため、ランナーで使用されるシェルに適切な構文を使用する必要があります。この例では、ワークフローは `ubuntu-latest` を指定します。既定では、Linux ランナーは Bash シェルを使用するため、構文 `$NAME` を使用する必要があります。既定では、Windows ランナーは PowerShell を使用するため、構文 `$env:NAME` を使用します。シェルについて詳しくは、「[GitHub Actions　のワークフロー構文](/ja/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell)」をご覧ください。\n\n## 複数のワークフローに対する構成変数の定義\n\n複数のワークフローにわたって使用する構成変数を作成し、[organization](#creating-configuration-variables-for-an-organization)、[リポジトリ](#creating-configuration-variables-for-a-repository)、または[環境](#creating-configuration-variables-for-an-environment)レベルでそれらを定義できます。\n\nたとえば、構成変数を使用して、organization レベルでツールを構築するために渡されるパラメーターの既定値を設定しながら、リポジトリ所有者がケースバイケースでこれらのパラメーターをオーバーライドできるようにします。\n\n構成変数を定義すると、`vars` コンテキストで自動的に使用できるようになります。詳しくは、「[`vars` コンテキストを使用した構成変数の値へのアクセス](#using-the-vars-context-to-access-configuration-variable-values)」をご覧ください。\n\n### リポジトリの構成変数の作成\n\nデータの再利用可能なアクション.パーミッションステートメント.シークレット.変数.リポジトリ %}\n\n1. GitHub で、リポジトリのメインページに移動します。\n2. リポジトリ名の下にある ** \\[Settings]** をクリックします。 \\[設定] タブが表示されない場合は、 **\\[]** ドロップダウンメニューを選び、 **\\[設定]** をクリックします。\n\n ![タブを示すリポジトリヘッダーのスクリーンショット。 \\[設定\\] タブが濃いオレンジ色の枠線で強調表示されています。](/assets/images/help/repository/repo-actions-settings.png)\n3. サイドバーの \\[Security] セクションで、** \\[Secrets and variables]** を選んでから、**\\[Actions]** をクリックします。\n4. **\\[変数]** タブをクリックします。\n ![\\[アクションシークレットと変数\\] ページのスクリーンショット。 \\[変数\\] タブが濃いオレンジ色の枠線で囲まれています。](/assets/images/help/repository/actions-variables-tab.png)\n5. ```\n **[新しいリポジトリ変数]** をクリックします。\n ```\n6. **\\[名前]** フィールドに、変数の名前を入力します。\n7. **\\[値]** フィールドに、変数の値を入力します。\n8. ```\n **[変数の追加]** をクリックします。\n ```\n\n### 環境の構成変数の作成\n\n個人用アカウントのリポジトリ内の環境でシークレットか変数を作成するユーザーは、そのリポジトリのオーナーである必要があります。組織用リポジトリ内の環境用にシークレットか変数を作成するユーザーには、`admin` のアクセス権が必要です。環境の詳細については、「[デプロイメント用の環境管理](/ja/actions/deployment/targeting-different-environments/managing-environments-for-deployment)」を参照してください。\n\n1. GitHub で、リポジトリのメインページに移動します。\n2. リポジトリ名の下にある ** \\[Settings]** をクリックします。 \\[設定] タブが表示されない場合は、 **\\[]** ドロップダウンメニューを選び、 **\\[設定]** をクリックします。\n\n ![タブを示すリポジトリヘッダーのスクリーンショット。 \\[設定\\] タブが濃いオレンジ色の枠線で強調表示されています。](/assets/images/help/repository/repo-actions-settings.png)\n3. 左側のサイドバーで、 **\\[環境]** をクリックします。\n4. 変数を追加したい環境をクリックしてください。\n5. ```\n **[環境変数]** で **[変数の追加]** をクリックします。\n ```\n6. **\\[名前]** フィールドに、変数の名前を入力します。\n7. **\\[値]** フィールドに、変数の値を入力します。\n8. ```\n **[変数の追加]** をクリックします。\n ```\n\n### 組織の構成変数の作成\n\nデータの再利用可能なアクション、アクションの秘密、変数、リポジトリへのアクセス %}\n\nOrganization のオーナーは、Organization レベルでシークレットまたは変数を作成できます。\n\n1. GitHub で、organization のメインページに移動します。\n\n2. Organization 名の下で、**\\[ Settings]** をクリックします。 \\[設定] タブが表示されない場合は、 **\\[]** ドロップダウンメニューを選び、 **\\[設定]** をクリックします。\n\n ![組織のプロファイルのタブのスクリーンショット。 \\[設定\\] タブが濃いオレンジ色の枠線で囲まれています。](/assets/images/help/discussions/org-settings-global-nav-update.png)\n\n3. サイドバーの \\[Security] セクションで、** \\[Secrets and variables]** を選んでから、**\\[Actions]** をクリックします。\n\n4. **\\[変数]** タブをクリックします。\n\n ![\\[アクションシークレットと変数\\] ページのスクリーンショット。 \\[変数\\] タブが濃いオレンジ色の枠線で囲まれています。](/assets/images/help/repository/actions-variables-tab.png)\n\n5. ```\n **[新しい Organization 変数]** をクリックします。\n ```\n\n6. **\\[名前]** フィールドに、変数の名前を入力します。\n\n7. **\\[値]** フィールドに、変数の値を入力します。\n\n8. ```\n **[リポジトリアクセス]** ドロップダウンリストから、アクセスポリシーを選びます。\n ```\n\n9. ```\n **[変数の追加]** をクリックします。\n ```\n\n## コンテキストを使用した変数の値へのアクセス\n\nコンテキストは、ワークフローの実行、変数、ランナーの環境、ジョブ、ステップに関する情報にアクセスする方法です。詳しくは、「[コンテキストリファレンス](/ja/actions/learn-github-actions/contexts)」をご覧ください。ワークフローには、さまざまな目的で使用できる他の多くのコンテキストがあります。ワークフロー内で特定のコンテキストを使用できる場所について詳しくは、「[コンテキストリファレンス](/ja/actions/learn-github-actions/contexts#context-availability)」をご覧ください。\n\n```\n `env` コンテキストを使用して環境変数値にアクセスし、`vars` コンテキストを使用して構成変数値にアクセスできます。\n```\n\n###\n\n```\n `env` コンテキストを使用した環境変数の値へのアクセス\n```\n\nGitHub Actions では、ランナー環境変数に加えて、コンテキストを使用した `env` キー値の設定および読み取りを行うことができます。環境変数やコンテキストは、ワークフロー中の様々な場所で利用できます。\n\nワークフローまたは参照先アクションの `run` ステップは、ランナーによって処理されます。その結果、ランナーで使用するシェル (Linux ランナーの bash シェル用の `$NAME` や Windows ランナーの PowerShell用の `$env:NAME` など) に適した構文を使用して、ランナー環境変数をここで使用できます。ほとんどの場合、コンテキストと構文 `${{ CONTEXT.PROPERTY }}` を使用して、同じ値にアクセスすることもできます。違いは、ジョブがランナーに送信される前にコンテキストが補間され、文字列に置き換えられるということです。\n\nただし、GitHub Actions によって処理され、ランナーには送信されないワークフローの一部のランナー環境変数値は使用できません。その代わりに、コンテキストを使用することができます。たとえば、ジョブまたはステップがランナーに送信されるかどうかを決定する `if` 条件は、常に GitHub Actions によって処理されます。したがって、変数の値にアクセスするには、 `if` 条件ステートメントでコンテキストを使用する必要があります。\n\n```yaml copy\nname: Conditional env variable\n\non: workflow_dispatch\n\nenv:\n DAY_OF_WEEK: Monday\n\njobs:\n greeting_job:\n runs-on: ubuntu-latest\n env:\n Greeting: Hello\n steps:\n - name: \"Say Hello Mona it's Monday\"\n if: ${{ env.DAY_OF_WEEK == 'Monday' }}\n run: echo \"$Greeting $First_Name. Today is $DAY_OF_WEEK!\"\n env:\n First_Name: Mona\n```\n\n前の例のこの変更では、`if` 条件を導入しました。ワークフローステップは、`DAY_OF_WEEK` が \"Monday\" に設定されている場合にのみ実行されます。\n`if`を使用して、`env` 条件付きステートメントからこの値にアクセスします。\n`env` コマンド内で参照される変数には、 `run` コンテキストは必要ありません。これらはランナー環境変数として参照され、ランナーがジョブを受信した後に補間されます。ただし、コンテキストを使用して、ランナーにジョブを送信する前に、これらの変数を補間することを選択できました。結果の出力は同じになります。\n\n```yaml\nrun: echo \"${{ env.Greeting }} ${{ env.First_Name }}. Today is ${{ env.DAY_OF_WEEK }}!\"\n```\n\n> \\[!NOTE]\n> コンテキストは通常、`${{ context.property }}` としてドル記号と中かっこを使用して示されます。\n> `if` 条件では、`${{` と `}}` は省略可能ですが、それらを使用する場合は、上記のように比較ステートメント全体を囲む必要があります。\n\nデータ再利用可能なアクション.コンテキスト挿入警告 %}\n\n###\n\n```\n `vars` コンテキストを使用した構成変数の値へのアクセス\n```\n\n構成変数には、`vars` コンテキストを使用してワークフロー全体でアクセスできます。詳しくは、「[コンテキストリファレンス](/ja/actions/learn-github-actions/contexts#vars-context)」をご覧ください。\n\n構成変数が設定されていない場合、変数を参照するコンテキストの戻り値は空の文字列になります。\n\n次の例は、ワークフロー全体で `vars` コンテキストと共に構成変数を使用する方法を示しています。次の各構成変数は、リポジトリ、Organization、または環境レベルで定義されています。\n\n```yaml copy\non:\n workflow_dispatch:\nenv:\n # Setting an environment variable with the value of a configuration variable\n env_var: ${{ vars.ENV_CONTEXT_VAR }}\n\njobs:\n display-variables:\n name: ${{ vars.JOB_NAME }}\n # You can use configuration variables with the `vars` context for dynamic jobs\n if: ${{ vars.USE_VARIABLES == 'true' }}\n runs-on: ${{ vars.RUNNER }}\n environment: ${{ vars.ENVIRONMENT_STAGE }}\n steps:\n - name: Use variables\n run: |\n echo \"repository variable : $REPOSITORY_VAR\"\n echo \"organization variable : $ORGANIZATION_VAR\"\n echo \"overridden variable : $OVERRIDE_VAR\"\n echo \"variable from shell environment : $env_var\"\n env:\n REPOSITORY_VAR: ${{ vars.REPOSITORY_VAR }}\n ORGANIZATION_VAR: ${{ vars.ORGANIZATION_VAR }}\n OVERRIDE_VAR: ${{ vars.OVERRIDE_VAR }}\n \n - name: ${{ vars.HELLO_WORLD_STEP }}\n if: ${{ vars.HELLO_WORLD_ENABLED == 'true' }}\n uses: actions/hello-world-javascript-action@main\n with:\n who-to-greet: ${{ vars.GREET_NAME }}\n```\n\n## オペレーティングシステムの検出\n\n既定の環境変数 `RUNNER_OS` と対応するコンテキストプロパティ `${{ runner.os }}` を使用して、異なるオペレーティングシステムに使用できる 1 つのワークフローファイルを記述できます。たとえば、ランナーによって使用されるシェルに応じて異なる、環境変数の構文を変更しなくても、オペレーティングシステムを `macos-latest` から `windows-latest` に変更した場合、次のワークフローを正常に実行できます。\n\n```yaml copy\non: workflow_dispatch\n\njobs:\n if-Windows-else:\n runs-on: macos-latest\n steps:\n - name: condition 1\n if: runner.os == 'Windows'\n run: echo \"The operating system on the runner is $env:RUNNER_OS.\"\n - name: condition 2\n if: runner.os != 'Windows'\n run: echo \"The operating system on the runner is not Windows, it's $RUNNER_OS.\"\n```\n\nこの例では、2 つの `if` ステートメントによって `os` コンテキストの `runner` プロパティがチェックされ、ランナーのオペレーティングシステムが決定されます。\n`if` 条件は GitHub Actions によって処理され、チェックによって `true` として解決されるステップのみ、ランナーに送信されます。ここでは、チェックの 1 つが常に `true` となり、もう 1 つが `false` になるため、これらのステップの 1 つだけがランナーに送信されます。ジョブがランナーに送信されると、ステップが実行され、`echo` コマンド内の環境変数が適切な構文を使用して補間されます (Windows の PowerShell `$env:NAME`、Linux および macOS の bash と sh `$NAME`)。この例では、ステートメント `runs-on: macos-latest` では 2 番目のステップが実行されます。\n\n## ワークフロー内のステップとジョブの間で値を渡す\n\nジョブの 1 つのステップで値を生成する場合は、既存または新しい環境変数に値を割り当て、これを `GITHUB_ENV` 環境ファイルに書き込むことで、同じジョブの後続のステップで値を使用できます。環境ファイルは、アクションによって直接使用することも、`run` キーワードを使用してワークフローファイル内のシェルコマンドから使用することもできます。詳しくは、「[GitHub Actions のワークフローコマンド](/ja/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable)」をご覧ください。\n\nワークフロー内のあるジョブのステップから、そのワークフロー内の別のジョブのステップに値を渡す場合は、その値をジョブ出力として定義できます。その後、別のジョブのステップからこのジョブ出力を参照できます。詳しくは、「[GitHub Actions　のワークフロー構文](/ja/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idoutputs)」をご覧ください。\n\n## 次のステップ\n\n参考情報については、「[変数リファレンス](/ja/actions/reference/variables-reference)」をご覧ください。"}