docs icon indicating copy to clipboard operation
docs copied to clipboard

Documentation for "Restrict who can push to matching branches" erroneously suggests feature is not for free plan

Open Marcono1234 opened this issue 2 years ago • 6 comments

Code of Conduct

What article on docs.github.com is affected?

  • https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule#creating-a-branch-protection-rule
  • https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#restrict-who-can-push-to-matching-branches

What part(s) of the article would you like to see updated?

Both pages say the following regarding the "Restrict who can push to matching branches" setting:

if your repository is owned by an organization using GitHub Team or GitHub Enterprise Cloud

This suggests the feature is not available for the "GitHub Free" plan. However, that does not seem to be true, this setting also seems to be available for organizations using GitHub Free (please check this yourself as well to be sure).

Though it looks like this setting is not available for personal (non-organization) projects, so maybe the documentation should only mention that and not refer to any pricing plan.

Additional information

No response

Marcono1234 avatar Nov 20 '22 17:11 Marcono1234

Thank you!


From: Marcono1234 @.***> Sent: Sunday, November 20, 2022 5:40:22 PM To: github/docs Cc: Subscribed Subject: [github/docs] Documentation for "Restrict who can push to matching branches" erroneously suggests feature is not for free plan (Issue #22181)

Code of Conduct

What article on docs.github.com is affected?

  • https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule#creating-a-branch-protection-rule
  • https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#restrict-who-can-push-to-matching-branches

What part(s) of the article would you like to see updated?

Both pages say the following regarding the "Restrict who can push to matching branches" setting:

if your repository is owned by an organization using GitHub Team or GitHub Enterprise Cloud

This suggests the feature is not available for the "GitHub Free" plan. However, that does not seem to be true, this setting also seems to be available for organizations using GitHub Free (please check this yourself as well to be sure).

Though it looks like this setting is not available for personal (non-organization) projects, so maybe the documentation should only mention that and not refer to any pricing plan.

Additional information

No response

— Reply to this email directly, view it on GitHubhttps://github.com/github/docs/issues/22181, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A2MGJ7ZFQSZW2PQ2DQVDYA3WJJPANANCNFSM6AAAAAASF6H34M. You are receiving this because you are subscribed to this thread.Message ID: @.***>

chrissygem42 avatar Nov 20 '22 18:11 chrissygem42

@Marcono1234 Thanks so much for opening an issue! I'll triage this for the team to take a look :eyes:

cmwilson21 avatar Nov 21 '22 17:11 cmwilson21

Thanks so much for catching this one @Marcono1234! You or anyone else is welcome to open a PR with the fix! Let's make the following changes:

  • In Managing a branch protection rule, let's change step 15 to:

    Optionally, in public repositories owned by a {% data variables.product.prodname_free_user %} organization and in all repositories owned by an organization using {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %}, enable branch restrictions.

  • In About protected branches, let's change the line to:

    You can enable branch restrictions in public repositories owned by a {% data variables.product.prodname_free_user %} organization and in all repositories owned by an organization using {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %}.

janiceilene avatar Dec 13 '22 09:12 janiceilene

Hey, there! If it isn't resolved yet, I would be happy to pick this up and fix it

dostonnabotov avatar Dec 13 '22 17:12 dostonnabotov

Okay go a head

On Tue, Dec 13, 2022, 9:54 AM Doston Nabotov @.***> wrote:

Hey, there! If it isn't resolved yet, I would be happy to pick this up and fix it

— Reply to this email directly, view it on GitHub https://github.com/github/docs/issues/22181#issuecomment-1349287521, or unsubscribe https://github.com/notifications/unsubscribe-auth/AVHUNFDJJA3XU6C56VCQY3TWNCZ5RANCNFSM6AAAAAASF6H34M . You are receiving this because you are subscribed to this thread.Message ID: @.***>

Wiatt99923 avatar Dec 13 '22 18:12 Wiatt99923

@dostonnabotov Thanks for reaching out! You or anyone else is welcome to submit a PR with this fix 💛

cmwilson21 avatar Dec 13 '22 19:12 cmwilson21