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 about-protected-branches.md | Move period inside ending quotation par with GitHub styling. #35201

Merged
merged 2 commits into from
Nov 6, 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 @@ -31,7 +31,7 @@

By default, each branch protection rule disables force pushes to the matching branches and prevents the matching branches from being deleted. You can optionally disable these restrictions and enable additional branch protection settings.

By default, the restrictions of a branch protection rule don't apply to people with admin permissions to the repository or custom roles with the "bypass branch protections" permission. You can optionally apply the restrictions to administrators and roles with the "bypass branch protections" permission, too. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization)".
By default, the restrictions of a branch protection rule don't apply to people with admin permissions to the repository or custom roles with the "bypass branch protections" permission. You can optionally apply the restrictions to administrators and roles with the "bypass branch protections" permission, too. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization)."

{% data reusables.repositories.branch-rules-example %} For more information about branch name patterns, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule)."

Expand All @@ -56,10 +56,10 @@
{% ifversion merge-queue %}
* [Require merge queue](#require-merge-queue)
{% endif %}
{%- ifversion required-deployments %}

Check warning on line 59 in content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md

View workflow job for this annotation

GitHub Actions / lint-content

Liquid `ifversion` (and `elsif`) should not always be true

The Liquid ifversion condition 'required-deployments' includes all possible versions and will always be true.
* [Require deployments to succeed before merging](#require-deployments-to-succeed-before-merging)
{%- endif %}
{%- ifversion lock-branch %}

Check warning on line 62 in content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md

View workflow job for this annotation

GitHub Actions / lint-content

Liquid `ifversion` (and `elsif`) should not always be true

The Liquid ifversion condition 'lock-branch' includes all possible versions and will always be true.
* [Lock branch](#lock-branch)
{%- endif %}
* [Do not allow bypassing the above settings](#do-not-allow-bypassing-the-above-settings)
Expand Down Expand Up @@ -92,13 +92,13 @@

Optionally, you can choose to require reviews from code owners. If you do, any pull request that affects code with a code owner must be approved by that code owner before the pull request can be merged into the protected branch.

{% ifversion last-pusher-require-approval %}

Check warning on line 95 in content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md

View workflow job for this annotation

GitHub Actions / lint-content

Liquid `ifversion` (and `elsif`) should not always be true

The Liquid ifversion condition 'last-pusher-require-approval' includes all possible versions and will always be true.
Optionally, you can require that the most recent reviewable push must be approved by someone other than the person who pushed it. This means at least one other authorized reviewer has approved any changes. For example, the "last reviewer" can check that the latest set of changes incorporates feedback from other reviews, and does not add new, unreviewed content.

For complex pull requests that require many reviews, requiring an approval from someone other than the last person to push can be a compromise that avoids the need to dismiss all stale reviews: with this option, "stale" reviews are not dismissed, and the pull request remains approved as long as someone other than the person who made the most recent changes approves it. Users who have already reviewed a pull request can reapprove after the most recent push to meet this requirement. If you are concerned about pull requests being "hijacked" (where unapproved content is added to approved pull requests), it is safer to dismiss stale reviews.
{% endif %}

{% ifversion pull-request-mergeability-security-changes %}

Check warning on line 101 in content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md

View workflow job for this annotation

GitHub Actions / lint-content

Liquid `ifversion` (and `elsif`) should not always be true

The Liquid ifversion condition 'pull-request-mergeability-security-changes' includes all possible versions and will always be true.
{% data reusables.pull_requests.security-changes-mergeability %}
{% endif %}

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

You can require that changes are successfully deployed to specific environments before a branch can be merged. For example, you can use this rule to ensure that changes are successfully deployed to a staging environment before the changes merge to your default branch.

{% ifversion lock-branch %}

Check warning on line 172 in content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md

View workflow job for this annotation

GitHub Actions / lint-content

Liquid `ifversion` (and `elsif`) should not always be true

The Liquid ifversion condition 'lock-branch' includes all possible versions and will always be true.

### Lock branch

Expand All @@ -192,11 +192,11 @@

When you enable branch restrictions, only users, teams, or apps that have been given permission can push to the protected branch. You can view and edit the users, teams, or apps with push access to a protected branch in the protected branch's settings. When status checks are required, the people, teams, and apps that have permission to push to a protected branch will still be prevented from merging into the branch when the required checks fail. People, teams, and apps that have permission to push to a protected branch will still need to create a pull request when pull requests are required.

{% ifversion restrict-pushes-create-branch %}

Check warning on line 195 in content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md

View workflow job for this annotation

GitHub Actions / lint-content

Liquid `ifversion` (and `elsif`) should not always be true

The Liquid ifversion condition 'restrict-pushes-create-branch' includes all possible versions and will always be true.
Optionally, you can apply the same restrictions to the creation of branches that match the rule. For example, if you create a rule that only allows a certain team to push to any branches that contain the word `release`, only members of that team would be able to create a new branch that contains the word `release`.
{% endif %}

You can only give push access to a protected branch, or give permission to create a matching branch, to users, teams, or installed {% data variables.product.prodname_github_apps %} with write access to a repository. People and apps with admin permissions to a repository are always able to push to a protected branch{% ifversion restrict-pushes-create-branch %} or create a matching branch{% endif %}.

Check warning on line 199 in content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md

View workflow job for this annotation

GitHub Actions / lint-content

Liquid `ifversion` (and `elsif`) should not always be true

The Liquid ifversion condition 'restrict-pushes-create-branch' includes all possible versions and will always be true.

### Allow force pushes

Expand Down
Loading