Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update managing-environments-for-deployment.md to clear wording ambiguity #35575

Merged
merged 1 commit into from
Dec 9, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

You can configure environments with protection rules and secrets. When a workflow job references an environment, the job won't start until all of the environment's protection rules pass. A job also cannot access secrets that are defined in an environment until all the deployment protection rules pass.

{% ifversion actions-break-glass %}Optionally, you can bypass an environment's protection rules and force all pending jobs referencing the environment to proceed. For more information, see "[AUTOTITLE](/actions/managing-workflow-runs/reviewing-deployments#bypassing-environment-protection-rules)."{% endif %}

Check warning on line 31 in content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md

View workflow job for this annotation

GitHub Actions / lint-content

The Liquid ifversion condition 'actions-break-glass' includes all possible versions and will always be true.

{% ifversion fpt %}

Expand All @@ -41,7 +41,7 @@

## Deployment protection rules

Deployment protection rules require specific conditions to pass before a job referencing the environment can proceed. You can use deployment protection rules to require a manual approval, delay a job, or restrict the environment to certain branches.{% ifversion actions-custom-deployment-protection-rules-beta %} You can also create and implement custom protection rules powered by {% data variables.product.prodname_github_apps %} to use third-party systems to control deployments referencing environments configured on {% data variables.product.github %}.

Check warning on line 44 in content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md

View workflow job for this annotation

GitHub Actions / lint-content

The Liquid ifversion condition 'actions-custom-deployment-protection-rules-beta' includes all possible versions and will always be true.

Third-party systems can be observability systems, change management systems, code quality systems, or other manual configurations that you use to assess readiness before deployments are safely rolled out to environments.

Expand Down Expand Up @@ -107,7 +107,7 @@

{% endif %}

{% ifversion actions-break-glass %}

Check warning on line 110 in content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md

View workflow job for this annotation

GitHub Actions / lint-content

The Liquid ifversion condition 'actions-break-glass' includes all possible versions and will always be true.

### Allow administrators to bypass configured protection rules

Expand All @@ -123,7 +123,7 @@
{% endif %}
{% endif %}

{% ifversion actions-custom-deployment-protection-rules-beta %}

Check warning on line 126 in content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md

View workflow job for this annotation

GitHub Actions / lint-content

The Liquid ifversion condition 'actions-custom-deployment-protection-rules-beta' includes all possible versions and will always be true.

### Custom deployment protection rules

Expand All @@ -149,7 +149,7 @@
{% ifversion fpt %}
> [!NOTE]
> * Workflows that run on self-hosted runners are not run in an isolated container, even if they use environments. Environment secrets should be treated with the same level of security as repository and organization secrets. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#hardening-for-self-hosted-runners)."
> * Environment secrets are only available in public repositories if you are using {% data variables.product.prodname_free_user %}. For access to environment secrets in private or internal repositories, you must use {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_enterprise %}. For more information on switching your plan, see "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/upgrading-your-accounts-plan)."
> * If you are using {% data variables.product.prodname_free_user %}, environment secrets are only available in public repositories. For access to environment secrets in private or internal repositories, you must use {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_enterprise %}. For more information on switching your plan, see "[AUTOTITLE](/billing/managing-the-plan-for-your-github-account/upgrading-your-accounts-plan)."

{% else %}

Expand Down Expand Up @@ -195,12 +195,12 @@
1. Select **Wait timer**.
1. Enter the number of minutes to wait.
1. Click **Save protection rules**.
{%- ifversion actions-break-glass %}

Check warning on line 198 in content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md

View workflow job for this annotation

GitHub Actions / lint-content

The Liquid ifversion condition 'actions-break-glass' includes all possible versions and will always be true.
1. Optionally, disallow bypassing configured protection rules. For more information, see "[Allow administrators to bypass configured protection rules](#allow-administrators-to-bypass-configured-protection-rules)."
1. Deselect **Allow administrators to bypass configured protection rules**.
1. Click **Save protection rules**.
{%- endif %}
{%- ifversion actions-custom-deployment-protection-rules-beta %}

Check warning on line 203 in content/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment.md

View workflow job for this annotation

GitHub Actions / lint-content

The Liquid ifversion condition 'actions-custom-deployment-protection-rules-beta' includes all possible versions and will always be true.
1. Optionally, enable any custom deployment protection rules that have been created with {% data variables.product.prodname_github_apps %}. For more information, see "[Custom deployment protection rules](#custom-deployment-protection-rules)."
1. Select the custom protection rule you want to enable.
1. Click **Save protection rules**.
Expand Down
Loading