Skip to main content

特定の環境へのデプロイ

ワークフローでデプロイ環境を指定します。

この記事で

前提条件

環境は、ワークフローで使う前に作成しておく必要があります。 「デプロイメント用の環境管理」を参照してください。

ワークフローで環境の使用

  1. 編集するワークフロー ファイルを開きます。

  2. 次の構文を使って、jobs.<job_id>.environment キーをワークフローに追加します。

    YAML
    jobs:
      JOB-ID:
        environment: ENVIRONMENT-NAME
    

    選んだジョブは、指定した環境に対して構成されているすべての規則の対象になります。

  3. 必要に応じて、次の構文を使って環境のデプロイ URL を指定します。

    YAML
    jobs:
      JOB-ID:
        environment:
            name: ENVIRONMENT-NAME
            url: URL
    

    次の場所に指定した URL が表示されます。

    • リポジトリのデプロイ ページ上
    • ワークフロー実行の視覚化グラフ内
    • (pull request がワークフローをトリガーする場合) pull request タイムラインの [View deployment] ボタンとして
  4. 必要に応じて、 deployment プロパティを追加して、配置オブジェクトが作成されないようにします。 falseに設定しても、ジョブは環境シークレットと変数にアクセスできますが、GitHub デプロイは作成されません。

    YAML
    jobs:
      JOB-ID:
        environment:
            name: ENVIRONMENT-NAME
            deployment: false
    

    これは、環境シークレットを必要とするが、実際には何もデプロイしていない CI またはテスト ジョブに役立ちます。 詳細については、「GitHub Actionsを使用したデプロイ」を参照してください。