環境

環境について

保護ルールとシークレットを持つ環境を設定できます。 ワークフローのジョブが環境を参照すると、その環境の保護ルールをすべてパスするまではジョブは開始されません。 すべての環境の保護ルールをパスするまで、ジョブは環境で定義されているシークレットにアクセスできません。

環境保護ルールと環境シークレットは、Enterprise プランのパブリックリポジトリとプライベートリポジトリでのみ使用できます。 Enterprise プラン以外でリポジトリをパブリックからプライベートに変換すると、設定された保護ルールまたは環境シークレットは無視され、環境を設定できなくなります。 リポジトリをパブリックに変換して戻せば、以前に設定されていた保護ルールや環境のシークレットにアクセスできるようになります。

環境の保護ルール

環境の保護ルールは、その環境を参照しているジョブが進行する前に特定の条件をパスすることを要求します。 環境保護ルールを使用して、手動による承認を要求したり、ジョブを遅延させたり、環境を特定のブランチに制限したりすることができます。

必須のレビュー担当者

必須のレビュー担当者を使って、特定の人もしくはTeamがその環境を参照するワークフローのジョブを承認しなければならないようにすることができます。 最大で6人のユーザもしくはTeamをレビュー担当者とすることができます。 レビュー担当者は、少なくともそのリポジトリの読み取りアクセス権を持っていなければなりません。 ジョブが進行するため承認が必要なレビュー担当者は1人だけです。

必須のレビュー担当者を持つ環境を参照しているジョブのレビューに関する詳しい情報については「デプロイメントのレビュー」を参照してください。

待機タイマー

ジョブが最初にトリガーされた後、特定の時間ジョブを遅延させるために、待機タイマーを使ってください。 時間（分）は、0から43,200（30日）の間の整数でなければなりません。

デプロイメントブランチ

デプロイメントブランチを使用して、環境にデプロイできるブランチを制限します。 環境のデプロイメントブランチのオプションは以下のとおりです。

• すべてのブランチ: リポジトリ内のすべてのブランチを環境にデプロイできます。

• 保護されたブランチ: 環境にデプロイできるのはブランチ保護ルールが有効になっているブランチのみです。 リポジトリ内のどのブランチにもブランチ保護ルールが定義されていない場合は、すべてのブランチをデプロイできます。 ブランチ保護ルールの詳細については、「保護されたブランチについて」を参照してください。

• 選択したブランチ: 環境にデプロイできるのは指定した名前パターンに一致するブランチのみです。

  たとえば、デプロイメントブランチルールとして releases/* を指定した場合、名前が releases/ で始まるブランチのみが環境にデプロイできます。 （ワイルドカード文字は / と一致しません。 release/ で始まり、追加の単一スラッシュを含むブランチを一致させるには、release/*/* を使用します。） main をデプロイメントブランチルールとして追加すると、main という名前のブランチも環境にデプロイできます。 デプロイメントブランチの構文オプションの詳細については、Ruby File.fnmatch documentation のドキュメントを参照してください。

環境のシークレット

環境に保存されたシークレットは、その環境を参照するワークフロージョブからのみ利用できます。 環境が承認を必要とするなら、ジョブは必須のレビュー担当者の一人が承認するまで環境のシークレットにアクセスできません。 シークレットに関する詳しい情報については「暗号化されたシークレット」を参照してください。

環境の作成

ユーザ アカウントのリポジトリで環境を設定するには、リポジトリのオーナーである必要があります。 Organizationのリポジトリで環境を設定するには、adminアクセス権を持っていなければなりません。

1. GitHubで、リポジトリのメインページにアクセスしてください。
2. リポジトリ名の下で Settings（設定）をクリックしてください。
3. 左のサイドバーで Environments（環境）をクリックしてください。
4. New environment（新しい環境）をクリックしてください。
5. 環境の名前を入力し、Configure environment（環境を設定）をクリックしてください。 環境名では、大文字と小文字は区別されません。 環境名は255文字を超えてはならず、リポジトリ内でユニークでなければなりません。
6. 環境保護ルールあるいは環境のシークレットを設定してください。

REST API を介して環境を作成および設定することもできます。 詳しい情報については、「環境」および「シークレット」を参照してください。

存在しない環境を参照するワークフローを実行すると、参照された名前を持つ環境が作成されます。 新しく作成される環境には、保護ルールやシークレットは設定されていません。 リポジトリのワークフローを編集できる人は、ワークフローファイルを通じて環境を作成できますが、その環境を設定できるのはリポジトリ管理者だけです。

環境の参照

ワークフロー内の各ジョブは、1つの環境を参照できます。 この環境を参照するとジョブがランナーに送信される前に、環境に設定された保護ルールをパスしなければなりません。 ジョブがランナーに送信されると、ジョブは環境のシークレットにアクセスできます。

ワークフローで環境を参照するための構文に関する詳しい情報については「GitHub Actionsのワークフロー構文」を参照してください。 必須のレビュー担当者を持つ環境を参照しているジョブのレビューに関する詳しい情報については「デプロイメントのレビュー」を参照してください。

ワークフローが環境を参照する場合、その環境はリポジトリのデプロイメントに現れます。 現在及び以前のデプロイメントの表示に関する詳細については「デプロイメント履歴の表示」を参照してください。

並行処理を使用して環境内のデプロイメントをシリアライズする

並行処理では、環境で一度に最大 1 つのデプロイメントが進行中で、1 つのデプロイメントが保留になるようにすることができます。 詳しい情報については、「GitHub Actionsのワークフロー構文」を参照してください。

環境の削除

ユーザ アカウントのリポジトリで環境を設定するには、リポジトリのオーナーである必要があります。 Organizationのリポジトリで環境を設定するには、adminアクセス権を持っていなければなりません。

環境を削除すると、その環境に関連づけられたすべてのシークレットと保護ルールが削除されます。 削除された環境の保護ルールのために待機していたジョブは、自動的に失敗します。

1. GitHubで、リポジトリのメインページにアクセスしてください。
2. リポジトリ名の下で Settings（設定）をクリックしてください。
3. 左のサイドバーで Environments（環境）をクリックしてください。
4. 削除する環境の横にある をクリックします。
5. I understand, delete this environment（分かりました、この環境を削除してください）をクリックしてください。

REST API を介して環境を削除することもできます。 詳しい情報については、「環境」を参照してください。