{"meta":{"title":"デプロイメント用の環境管理","intro":"環境を作成し、デプロイ保護ルールで環境をセキュリティで保護できます。環境を参照するジョブは、環境のシークレットを実行またはそれにアクセスする前に、環境の保護ルールに従う必要があります。","product":"GitHub Actions","breadcrumbs":[{"href":"/ja/actions","title":"GitHub Actions"},{"href":"/ja/actions/how-tos","title":"方法"},{"href":"/ja/actions/how-tos/deploy","title":"デプロイ"},{"href":"/ja/actions/how-tos/deploy/configure-and-manage-deployments","title":"デプロイの構成と管理"},{"href":"/ja/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments","title":"環境の管理"}],"documentType":"article"},"body":"# デプロイメント用の環境管理\n\n環境を作成し、デプロイ保護ルールで環境をセキュリティで保護できます。環境を参照するジョブは、環境のシークレットを実行またはそれにアクセスする前に、環境の保護ルールに従う必要があります。\n\n## 前提条件\n\n> \\[!NOTE]\n> GitHub Free プランを持つユーザーは、パブリックリポジトリの環境のみを構成できます。リポジトリをパブリックからプライベートに変換すると、設定された保護ルールや環境のシークレットは無視されるようになり、環境は設定できなくなります。リポジトリをパブリックに変換して戻せば、以前に設定されていた保護ルールや環境のシークレットにアクセスできるようになります。\n>\n> GitHub Teamを持つ組織とGitHub Proを持つユーザーは、プライベートリポジトリの環境を構成できます。詳しくは、「[GitHubのプラン](/ja/get-started/learning-about-github/githubs-plans)」をご覧ください。\n\n* 環境の一般的な情報については、「[GitHub Actionsを使用したデプロイ](/ja/actions/how-tos/deploy/configure-and-manage-deployments/control-deployments#using-environments)」をご覧ください。\n* 使用できる規則については、「[デプロイメントと環境](/ja/actions/reference/workflows-and-actions/deployments-and-environments)」をご覧ください。\n\n## 環境の作成\n\n個人アカウントのリポジトリで環境を設定するには、リポジトリの所有者である必要があります。組織のリポジトリに環境を設定するには、`admin` アクセスが必要です。\n\n> \\[!NOTE]\n>\n> * プライベートリポジトリ内の環境の作成は、 GitHub Team を持つ組織と、 GitHub Proを持つユーザーが利用できます。\n> * 環境の一部の機能には、プライベートリポジトリの可用性がないか、制限されています。以下の手順で説明されている機能にアクセスできない場合は、関連する手順でリンクされている可用性情報のドキュメントを参照してください。\n\n1. GitHub で、リポジトリのメインページに移動します。\n2. リポジトリ名の下にある ** \\[Settings]** をクリックします。 \\[設定] タブが表示されない場合は、 **\\[]** ドロップダウンメニューを選び、 **\\[設定]** をクリックします。\n\n ![タブを示すリポジトリヘッダーのスクリーンショット。 \\[設定\\] タブが濃いオレンジ色の枠線で強調表示されています。](/assets/images/help/repository/repo-actions-settings.png)\n3. 左側のサイドバーで、 **\\[環境]** をクリックします。\n4. **\\[新しい環境]** をクリックします。\n5. 環境の名前を入力し、 **\\[環境の構成]** をクリックします。環境名では、大文字と小文字は区別されません。環境名は255文字を超えてはならず、リポジトリ内でユニークでなければなりません。\n6. 必要に応じて、この環境を使用するワークフロージョブを承認する必要があるユーザーまたはチームを指定します。詳しくは、「[デプロイメントと環境](/ja/actions/reference/workflows-and-actions/deployments-and-environments#required-reviewers)」をご覧ください。\n 1. **\\[必要なレビュー担当者]** を選択します。\n 2. 最大 6 人のユーザーまたはチームを入力します。ジョブが進行するため承認が必要なレビュー担当者は1人だけです。\n 3. 必要に応じて、ユーザーがトリガーしたワークフローの実行を承認できないようにするには、**\\[Prevent self-review]** を選びます。\n 4. **\\[保護ルールの保存]** をクリックします。\n7. 必要に応じて、この環境を使用するワークフロージョブの続行を許可するまでの待機時間を指定します。詳しくは、「[デプロイメントと環境](/ja/actions/reference/workflows-and-actions/deployments-and-environments#wait-timer)」をご覧ください。\n 1. **\\[待機タイマー]** を選択します。\n 2. 待機時間の分数を入力してください。\n 3. **\\[保護ルールの保存]** をクリックします。\n8. 必要に応じて、構成された保護規則のバイパスを禁止します。詳しくは、「[デプロイメントと環境](/ja/actions/reference/workflows-and-actions/deployments-and-environments#allow-administrators-to-bypass-configured-protection-rules)」をご覧ください。\n 1. **\\[構成された保護規則を管理者がバイパスすることを許可する]** をオフにします。\n 2. **\\[保護ルールの保存]** をクリックします。\n9. 必要に応じて、 GitHub Appsで作成されたカスタム展開保護規則を有効にします。詳しくは、「[デプロイメントと環境](/ja/actions/reference/workflows-and-actions/deployments-and-environments#custom-deployment-protection-rules)」をご覧ください。\n 1. 有効にするカスタム保護規則を選びます。\n 2. **\\[保護ルールの保存]** をクリックします。\n10. 必要に応じて、この環境に配置できるブランチとタグを指定します。詳しくは、「[デプロイメントと環境](/ja/actions/reference/workflows-and-actions/deployments-and-environments#deployment-branches-and-tags)」をご覧ください。\n 1. **\\[デプロイブランチ]** ドロップダウンで目的のオプションを選択します。\n\n 2. **Selected branches and tags** を選択した場合、新しい規則を追加するには、**デプロイメントブランチまたはタグルールの追加** をクリックします\n\n 3. \\[参照の種類] ドロップダウンメニューで、適用するルールに応じて、\\[**ブランチ**] または **\\[ タグ**] をクリックします。\n\n 4. 許可するブランチまたはタグの名前パターンを入力します。\n\n > \\[!NOTE]\n > 名前パターンは、ブランチまたはタグに対して個別に構成する必要があります。\n\n 5. **\\[ルールの追加]** をクリックします。\n11. 必要に応じて、環境シークレットを追加します。これらのシークレットは、環境を使用するワークフロージョブでのみ使用できます。さらに、この環境を使用するワークフロージョブで、これらのシークレットにアクセスできるのは、構成済みのルール (必須のレビュー担当者など) が合格した後に限られています。詳しくは、「[デプロイメントと環境](/ja/actions/reference/workflows-and-actions/deployments-and-environments#environment-secrets)」をご覧ください。\n 1. **\\[環境シークレット]** で、 **\\[シークレットの追加]** をクリックします。\n 2. シークレット名を入力します。\n 3. シークレット値を入力します。\n 4. **\\[シークレットの追加]** をクリックします。\n12. 必要に応じて、環境変数を追加します。これらの変数は、その環境を使用するワークフロージョブでのみ利用でき、[`vars`](/ja/actions/reference/workflows-and-actions/contexts#vars-context) コンテキストを使用してのみアクセスできます。詳しくは、「[デプロイメントと環境](/ja/actions/reference/workflows-and-actions/deployments-and-environments#environment-variables)」をご覧ください。\n 1. **\\[環境変数]** で **\\[変数の追加]** をクリックします。\n 2. 変数名を入力します。\n 3. 変数の値を入力します。\n 4. **\\[変数の追加]** をクリックします。\n\nREST API を介して環境を作成および設定することもできます。詳しくは、「[デプロイメント環境向けREST APIエンドポイント](/ja/rest/deployments/environments)」、「[GitHub Actions シークレットの REST API エンドポイント](/ja/rest/actions/secrets)」、「[GitHub Actions変数の REST API エンドポイント](/ja/rest/actions/variables)」、「[デプロイブランチポリシー用の REST API エンドポイント](/ja/rest/deployments/branch-policies)」を参照してください。\n\n存在しない環境を参照するワークフローを実行すると、参照された名前を持つ環境が作成されます。暗黙的なページビルドの実行 (ブランチやフォルダーソースなど) から環境が作成された場合、ソースブランチは保護ルールとして環境に追加されます。新しく作成される環境には、保護ルールやシークレットは設定されていません。リポジトリのワークフローを編集できる人は、ワークフローファイルを通じて環境を作成できますが、その環境を設定できるのはリポジトリ管理者だけです。\n\n## 環境の削除\n\n個人アカウントのリポジトリで環境を設定するには、リポジトリの所有者である必要があります。組織のリポジトリに環境を設定するには、`admin` アクセスが必要です。\n\n環境を削除すると、その環境に関連づけられたすべてのシークレットと保護ルールが削除されます。削除された環境の保護ルールのために待機していたジョブは、自動的に失敗します。\n\n1. GitHub で、リポジトリのメインページに移動します。\n2. リポジトリ名の下にある ** \\[Settings]** をクリックします。 \\[設定] タブが表示されない場合は、 **\\[]** ドロップダウンメニューを選び、 **\\[設定]** をクリックします。\n\n ![タブを示すリポジトリヘッダーのスクリーンショット。 \\[設定\\] タブが濃いオレンジ色の枠線で強調表示されています。](/assets/images/help/repository/repo-actions-settings.png)\n3. 左側のサイドバーで、 **\\[環境]** をクリックします。\n4. 削除する環境の横にある \\[ ] をクリックします。\n5. **\\[わかりました、この環境を削除してください]** をクリックします。\n\nREST API を介して環境を削除することもできます。詳しくは、「[リポジトリの REST API エンドポイント](/ja/rest/repos#environments)」をご覧ください。\n\n## 環境とデプロイの関係\n\n環境を参照するワークフロージョブが実行されると、`environment` プロパティに環境の名前が設定された展開オブジェクトが作成されます。ワークフローが進行すると、`environment` プロパティに環境の名前、`environment_url` プロパティに環境の URL (ワークフローで指定されている場合)、および `state` プロパティにジョブの状態が設定された展開状態オブジェクトも作成されます。\n\nこれらのオブジェクトには、REST API または GraphQL API を介してアクセスできます。これらの Webhook イベントをサブスクライブすることもできます。詳細については、「[リポジトリの REST API エンドポイント](/ja/rest/repos#deployments)」、「[デプロイ](/ja/graphql/reference/deployments#object-deployment)」(GraphQL API)、または「[Webhook のイベントとペイロード](/ja/webhooks/webhook-events-and-payloads#deployment)」を参照してください。\n\n## 次のステップ\n\nGitHub Actions には、デプロイを管理するためのいくつかの機能が用意されています。詳しくは、「[GitHub Actionsを使用したデプロイ](/ja/actions/how-tos/deploy/configure-and-manage-deployments/control-deployments)」をご覧ください。"}