Managing environments for deployment

Prerequisites

For general information about environments, see Deploying with GitHub Actions.
For information about available rules, see Deployments and environments.

Creating an environment

Чтобы настроить среду в репозитории, относящемся к учетной записи пользователя, необходимо быть владельцем репозитория. Чтобы настроить среду в репозитории организации, необходимо иметь доступ уровня admin.

На GitHubперейдите на главную страницу репозитория.
Под именем репозитория щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".
На левой боковой панели щелкните Среды.
Выберите Новая среда.
Введите имя среды и нажмите кнопку Настроить среду. В именах сред регистр не учитывается. Имя среды не может превышать 255 символов и должно быть уникальным в репозитории.
Optionally, specify people or teams that must approve workflow jobs that use this environment. For more information, see Deployments and environments.
1. Select Required reviewers.
2. Enter up to 6 people or teams. Only one of the required reviewers needs to approve the job for it to proceed.
3. Optionally, to prevent users from approving workflows runs that they triggered, select Prevent self-review.
4. Click Save protection rules.
Optionally, specify the amount of time to wait before allowing workflow jobs that use this environment to proceed. For more information, see Deployments and environments.
1. Select Wait timer.
2. Enter the number of minutes to wait.
3. Click Save protection rules.
Optionally, disallow bypassing configured protection rules. For more information, see Deployments and environments.
1. Deselect Allow administrators to bypass configured protection rules.
2. Click Save protection rules.
Optionally, enable any custom deployment protection rules that have been created with GitHub Apps. For more information, see Deployments and environments.
1. Select the custom protection rule you want to enable.
2. Click Save protection rules.
Optionally, specify what branches and tags can deploy to this environment. For more information, see Deployments and environments.
1. Select the desired option in the Deployment branches dropdown.
2. If you chose Selected branches and tags, to add a new rule, click Add deployment branch or tag rule
3. In the "Ref type" dropdown menu, depending on what rule you want to apply, click Branch or Tag.
4. Enter the name pattern for the branch or tag that you want to allow.
  
  Примечание.
  
  Шаблоны имен должны быть настроены для ветвей или тегов по отдельности.
5. Click Add rule.
Optionally, add environment secrets. These secrets are only available to workflow jobs that use the environment. Additionally, workflow jobs that use this environment can only access these secrets after any configured rules (for example, required reviewers) pass. For more information, see Deployments and environments.
1. Under Environment secrets, click Add Secret.
2. Enter the secret name.
3. Enter the secret value.
4. Click Add secret.
Optionally, add environment variables. These variables are only available to workflow jobs that use the environment, and are only accessible using the vars context. For more information, see Deployments and environments.
1. Under Environment variables, click Add Variable.
2. Enter the variable name.
3. Enter the variable value.
4. Click Add variable.

You can also create and configure environments through the REST API. For more information, see Конечные точки REST API для сред развертывания, Конечные точки REST API для секретов GitHub Actions, Конечные точки REST API для переменных GitHub Actions, and Конечные точки REST API для политик ветви развертывания.

Running a workflow that references an environment that does not exist will create an environment with the referenced name. If the environment is created from running implicit page builds (for example, from a branch or folder source), the source branch will be added as a protection rule to the environment. Otherwise, the newly created environment will not have any protection rules or secrets configured. Anyone that can edit workflows in the repository can create environments via a workflow file, but only repository admins can configure the environment.

Deleting an environment

Чтобы настроить среду в репозитории, относящемся к учетной записи пользователя, необходимо быть владельцем репозитория. Чтобы настроить среду в репозитории организации, необходимо иметь доступ уровня admin.

Deleting an environment will delete all secrets and protection rules associated with the environment. Any jobs currently waiting because of protection rules from the deleted environment will automatically fail.

На GitHubперейдите на главную страницу репозитория.
Под именем репозитория щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".
На левой боковой панели щелкните Среды.
Next to the environment that you want to delete, click .
Click I understand, delete this environment.

You can also delete environments through the REST API. For more information, see Конечные точки REST API для репозиториев.

How environments relate to deployments

При выполнении задания рабочего процесса, ссылающегося на среду, создается объект развертывания со свойством environment с названием вашей среды. По мере выполнения рабочего процесса создаются объекты состояния развертывания со свойством environment — имя вашей среды, свойством environment_url — URL-адрес среды (если указано в рабочем процессе), и свойством state — состояние задания.

You can access these objects through the REST API or GraphQL API. You can also subscribe to these webhook events. For more information, see Конечные точки REST API для репозиториев, Объект (GraphQL API), or События и полезные данные веб-перехватчика.

Next steps

GitHub Actions provides several features for managing your deployments. For more information, see Deploying with GitHub Actions.