ジョブに環境を使用する

注: GitHub ホステッドランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。

概要

ジョブが参照する環境を定義するには、jobs.<job_id>.environment を使います。環境を参照するジョブがランナーに送られる前に、その環境のすべてのデプロイ保護ルールをパスしなければなりません。詳しくは、「デプロイに環境を使用する」を参照してください。

環境 name のみ、または name と url を含む環境オブジェクトという形式で環境を指定できます。 URL はデプロイ API の environment_url にマップされます。デプロイ API の詳細については、「リポジトリの REST API エンドポイント」を参照してください。

例: 1 つの環境名を使う

environment: staging_environment

例: 環境名と URL を使う

environment:
  name: production_environment
  url: https://github.com

url の値には式を指定できます。使用できる式コンテキスト: github、inputs、vars、needs、strategy、matrix、job、runner、env。式の詳細については、「式」を参照してください。

例: 出力を URL として使う

environment:
  name: production_environment
  url: ${{ steps.step_id.outputs.url_output }}

name の値には式を指定できます。使用できる式コンテキスト: github、inputs、vars、needs、strategy、matrix。式の詳細については、「式」を参照してください。

例: 環境名として式を使用する

environment:
  name: ${{ github.ref_name }}