Skip to content

Commit 37e18ca

Browse files
authored
Merge pull request #34442 from github/repo-sync
Repo sync
2 parents 8cace96 + 1e6fb5b commit 37e18ca

File tree

10 files changed

+148
-90
lines changed

10 files changed

+148
-90
lines changed

content/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles.md

Lines changed: 43 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: About custom organization roles
3-
intro: "You can control access to your organization's settings with custom organization roles."
3+
intro: "You can control access to your {% ifversion org-custom-role-with-repo-permissions %}organization and repository's{% else %} organization's{% endif %} settings with custom organization roles."
44
versions:
55
feature: 'custom-org-roles'
66
topics:
@@ -10,20 +10,28 @@ permissions: 'Organization owners and users with the "Manage custom organization
1010
product: 'Organizations on {% data variables.product.prodname_ghe_cloud %}{% ifversion ghes %} and {% data variables.product.prodname_ghe_server %}{% endif %}'
1111
---
1212

13-
## About custom organization roles
14-
1513
{% data reusables.organizations.custom-org-roles-intro %}
1614

17-
You can create and assign custom organization roles in your organization's settings. You can also manage custom roles using the REST API. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-organization-roles)."
15+
You can create and assign custom organization roles in your organization's settings. You can also manage custom roles using the REST API. See "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-organization-roles)."
1816

19-
Organization permissions do not grant read, write, or administrator access to any repositories. Some permissions may implicitly grant visibility of repository metadata, as marked in the table below.
17+
{% ifversion org-custom-role-with-repo-permissions %}
18+
19+
You can also create a custom organization role that includes permissions for repositories. Repository permissions grant access to all current and future repositories in the organization. There are several ways to combine permissions for repositories and organizations. You can create a custom organization role with:
20+
21+
You can create a role that includes permissions for organization settings, a base role for repository access, or both. If you add a base role for repository access, you can also include additional repository permissions. You can't create a role with repository permissions unless it includes a base repository role. Without repository permissions or a base repository role, the organization role doesn't grant access to any repositories.
22+
23+
>[!NOTE] Adding repository permissions to a custom organization role is currently in public beta and subject to change.
2024
21-
To granularly control access to your organization's repositories, you can create a custom repository role. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/about-custom-repository-roles)."
25+
{% endif %}
2226

23-
## Permissions for custom roles
27+
To grant access to **specific** repositories in your organization, you can create a custom repository role. See "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/about-custom-repository-roles)."
28+
29+
## Permissions for organization access
2430

2531
When you include a permission in a custom organization role, any users with that role will have access to the corresponding settings via both the web browser and API. In the organization's settings in the browser, users will see only the pages for settings they can access.
2632

33+
Organization permissions do not grant read, write, or administrator access to any repositories. Some permissions may implicitly grant visibility of repository metadata, as marked in the table below.
34+
2735
{% rowheaders %}
2836

2937
| Permission | Description | More information |
@@ -56,3 +64,31 @@ Manage organization OAuth application policies | Access to the "OAuth applicatio
5664
| {% endif %} |
5765

5866
{% endrowheaders %}
67+
68+
{% ifversion org-custom-role-with-repo-permissions %}
69+
70+
## Base roles for repository access
71+
72+
The base repository role determines the initial set of permissions included in the custom role. Repository access is granted across **all** current and future repositories in the organization.
73+
74+
The base repository roles are:
75+
76+
* **Read**: Grants read access to all repositories in the organization.
77+
* **Write**: Grants write access to all repositories in the organization.
78+
* **Triage**: Grants triage access to all repositories in the organization.
79+
* **Maintain**: Grants maintenance access to all repositories in the organization.
80+
* **Admin**: Grants admin access to all repositories in the organization.
81+
82+
## Additional permissions for repository access
83+
84+
After choosing a base repository role, you can select additional permissions for your custom organization role.
85+
86+
You can only choose an additional permission if it's not already included in the base repository role. For example, if the base role offers **Write** access to a repository, then the "Close a pull request" permission will already be included in the base role.
87+
88+
{% data reusables.organizations.additional-permissions %}
89+
90+
## Precedence for different levels of access
91+
92+
{% data reusables.organizations.precedence-for-different-levels %}
93+
94+
{% endif %}

content/organizations/managing-peoples-access-to-your-organization-with-roles/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ topics:
1414
- Teams
1515
children:
1616
- /roles-in-an-organization
17+
- /using-organization-roles
1718
- /about-custom-organization-roles
1819
- /managing-custom-organization-roles
19-
- /using-organization-roles
2020
- /maintaining-ownership-continuity-for-your-organization
2121
- /adding-a-billing-manager-to-your-organization
2222
- /removing-a-billing-manager-from-your-organization

content/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@
22
title: Using organization roles
33
intro: "Learn how to{% ifversion org-pre-defined-roles %} view organization role permissions and{% endif %} manage organization role assignments."
44
versions:
5-
feature: 'custom-org-roles'
5+
fpt: '*'
6+
ghec: '*'
7+
ghes: '>=3.14'
68
topics:
79
- Organizations
810
- Access management
911
- Administrator
1012
- Permissions
1113
permissions: 'Organization owners{% ifversion ghec %} and users with the "Manage custom organization roles" permission{% endif %}'
1214
product: 'Organizations on {% data variables.product.prodname_free_team %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}'
13-
shortTitle: Using organization roles
15+
shortTitle: Use organization roles
1416
---
1517

1618
## About organization roles

content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/about-custom-repository-roles.md

Lines changed: 5 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ You can also use the REST API to create and manage custom repository roles. For
3030
{% endif %}
3131

3232
{% ifversion custom-org-roles %}
33-
Custom repository roles manage access to repositories in your organization. To granularly control access to your organization's administration settings, you can use custom organization roles. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
33+
Custom repository roles manage access to specific repositories in your organization. To {% ifversion org-custom-role-with-repo-permissions %}grant access to all repositories, and to {% endif %}control access to your organization's administration settings, you can use custom organization roles. See "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
34+
35+
Custom organization roles differ from repository roles by granting permissions across **all** current and future repositories in the organization. Custom repository roles, however, allow you to grant permissions to **specific** repositories within the organization.
3436
{% endif %}
3537

3638
## About the inherited role
@@ -62,79 +64,8 @@ After choosing an inherited role, you can select additional permissions for your
6264

6365
You can only choose an additional permission if it's not already included in the inherited role. For example, if the inherited role offers **Write** access to a repository, then the "Close a pull request" permission will already be included in the inherited role.
6466

65-
{% ifversion discussions %}
66-
67-
### Discussions
68-
69-
* Create a discussion category
70-
* Edit a discussion category
71-
* Delete a discussion category
72-
* Mark or unmark discussion answers
73-
* Hide or unhide discussion comments
74-
* Convert issues to discussions
75-
76-
For more information, see "[AUTOTITLE](/discussions)."
77-
{% endif %}
78-
79-
### Issue and Pull Requests
80-
81-
* Assign or remove a user
82-
* Add or remove a label
83-
84-
### Issue
85-
86-
* Close an issue
87-
* Reopen a closed issue
88-
* Delete an issue
89-
* Mark an issue as a duplicate
90-
91-
### Pull Request
92-
93-
* Close a pull request
94-
* Reopen a closed pull request
95-
* Request a pull request review
96-
97-
### Repository
98-
99-
* Set milestones
100-
* Manage wiki settings
101-
* Manage project settings
102-
* Manage pull request merging settings
103-
* Manage {% data variables.product.prodname_pages %} settings (see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)")
104-
* Manage webhooks
105-
* Manage deploy keys
106-
* Edit repository metadata
107-
{%- ifversion ghec %}
108-
* Set interaction limits
109-
{%- endif %}
110-
* Set the social preview
111-
* Push commits to protected branches
112-
* Base role must be `write`
113-
* Branch protection rules will still apply
114-
* Create protected tags
115-
* Delete protected tags
116-
* Bypass branch protections
117-
{%- ifversion edit-repository-rules %}
118-
* Edit repository rules
119-
{%- endif %}
120-
121-
### Security
122-
123-
* View {% data variables.product.prodname_code_scanning %} results
124-
* Dismiss or reopen {% data variables.product.prodname_code_scanning %} results
125-
* Delete {% data variables.product.prodname_code_scanning %} results
126-
* View {% data variables.product.prodname_dependabot_alerts %}
127-
* Dismiss or reopen {% data variables.product.prodname_dependabot_alerts %}
128-
* View {% data variables.product.prodname_secret_scanning %} results
129-
* Dismiss or reopen {% data variables.product.prodname_secret_scanning %} results
67+
{% data reusables.organizations.additional-permissions %}
13068

13169
## Precedence for different levels of access
13270

133-
If a person is given different levels of access through different avenues, such as team membership and the base permissions for an organization, the highest access overrides the others. For example, if an organization owner gives an organization member a custom role that uses the "Read" inherited role, and then an organization owner sets the organization's base permission to "Write", then this custom role will have write access, along with any additional permissions included in the custom role.
134-
135-
{% data reusables.organizations.mixed-roles-warning %}
136-
137-
To resolve conflicting access, you can adjust your organization's base permissions or the team's access, or edit the custom role. For more information, see:
138-
* "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization)"
139-
* "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)"
140-
* "[Editing a repository role](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization#editing-a-repository-role)"
71+
{% data reusables.organizations.precedence-for-different-levels %}

content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ If you're a member of an {% data variables.enterprise.prodname_emu_enterprise %}
3333

3434
For more information about repository roles, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository)" and "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)."
3535

36-
![Screenshot of the "Manage access" page for a repository.](/assets/images/help/repository/manage-access-overview.png)
37-
3836
## Filtering the list of teams and people
3937

4038
{% data reusables.repositories.navigate-to-repo %}
4139
{% data reusables.repositories.sidebar-settings %}
4240
{% data reusables.repositories.click-collaborators-teams %}
43-
1. Under "Manage access", in the search field, start typing the name of the team or person you'd like to find. Optionally, use the dropdown menus to filter your search.
41+
1. Under "Manage access", in the search field, start typing the name of the team or person you'd like to find. Optionally, use the dropdown menus to filter your search. {% ifversion org-custom-role-with-repo-permissions %}
42+
43+
You can also toggle between the **Direct access** and **Organization access** tabs to view who has direct access to the repository and who can access the repository via a team or organization role.{% endif %}
4444

4545
## Changing permissions for a team or person
4646

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Issue #11307
2+
# Documentation for custom organization roles can include repository permissions
3+
versions:
4+
ghec: '*'
5+
ghes: '>=3.15'
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
{% ifversion discussions %}
2+
3+
### Discussions
4+
5+
* Create a discussion category
6+
* Edit a discussion category
7+
* Delete a discussion category
8+
* Mark or unmark discussion answers
9+
* Hide or unhide discussion comments
10+
* Convert issues to discussions
11+
12+
For more information, see "[AUTOTITLE](/discussions)."
13+
{% endif %}
14+
15+
### Issue and Pull Requests
16+
17+
* Assign or remove a user
18+
* Add or remove a label
19+
20+
### Issue
21+
22+
* Close an issue
23+
* Reopen a closed issue
24+
* Delete an issue
25+
* Mark an issue as a duplicate
26+
27+
### Pull Request
28+
29+
* Close a pull request
30+
* Reopen a closed pull request
31+
* Request a pull request review
32+
33+
### Repository
34+
35+
* Set milestones
36+
* Manage wiki settings
37+
* Manage project settings
38+
* Manage pull request merging settings
39+
* Manage {% data variables.product.prodname_pages %} settings (see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)")
40+
* Manage webhooks
41+
* Manage deploy keys
42+
* Edit repository metadata
43+
{%- ifversion ghec %}
44+
* Set interaction limits
45+
{%- endif %}
46+
* Set the social preview
47+
* Push commits to protected branches
48+
* Base role must be `write`
49+
* Branch protection rules will still apply
50+
* Create protected tags
51+
* Delete protected tags
52+
* Bypass branch protections
53+
{%- ifversion edit-repository-rules %}
54+
* Edit repository rules
55+
{%- endif %}
56+
57+
### Security
58+
59+
* View {% data variables.product.prodname_code_scanning %} results
60+
* Dismiss or reopen {% data variables.product.prodname_code_scanning %} results
61+
* Delete {% data variables.product.prodname_code_scanning %} results
62+
* View {% data variables.product.prodname_dependabot_alerts %}
63+
* Dismiss or reopen {% data variables.product.prodname_dependabot_alerts %}
64+
* View {% data variables.product.prodname_secret_scanning %} results
65+
* Dismiss or reopen {% data variables.product.prodname_secret_scanning %} results
Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
11
1. Click **Create a role**.
2-
1. Type a name and description for the custom role.
3-
1. Under "Add permissions", click the text field, then select the permissions you want to add to the custom role. For more information about the available permissions, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles#additional-permissions-for-custom-roles)."
2+
1. Type a name and description for the custom role.{% ifversion org-custom-role-with-repo-permissions %}
3+
1. Under "Add permissions", click the **Organization** or **Repository** tab to select the type of permissions you want to add to the custom role.
4+
5+
* To add permissions for the organization, click the **Organization** tab, then select the dropdown menu and click the permissions you want your custom role to include.
6+
* To choose a base repository role to inherit, click the **Repository** tab, then select the dropdown menu and click the base role you want to include in the custom role. For more information about the available base repository roles, see "[Base roles for repository access](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles#base-roles-for-repository-access)."
7+
8+
Once you've selected a base repository role, you can add additional permissions to the custom role. For more information about the available permissions, see "[Additional permissions for repository access](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles#additional-permissions-for-repository-access)."
9+
10+
>[!NOTE] Adding a repository role and permissions to a custom organization role is currently in public beta and subject to change.
11+
12+
{% else %}
13+
1. Under "Add permissions", click the text field, then select the permissions you want to add to the custom role. For more information about the available permissions, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles#additional-permissions-for-custom-roles)."{% endif %}
414
1. Click **Create role**.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
You can have more granular control over the access you grant to your organization's settings by creating custom organization roles. Organization roles are a way to grant an organization member the ability to administer certain subsets of settings without granting full administrative control of the organization and its repositories. For example, you could create a role that contains the "View organization audit log" permission.
1+
You can have more granular control over the access you grant to your {% ifversion org-custom-role-with-repo-permissions %}organization and repository's{% else %} organization's{% endif %} settings by creating custom organization roles. Organization roles are a way to grant an organization member the ability to administer certain subsets of settings without granting full administrative control of the organization and its repositories. For example, you could create a role that contains the "View organization audit log" permission.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Roles and permissions are additive. If a person is given different levels of access through different avenues, such as team membership and the base permissions for an organization, the user has the sum of all access grants. For example, if an organization owner gives an organization member a custom role that uses the "Read" inherited role, and then an organization owner sets the organization's base permission to "Write", then members with the custom role will have write access, along with any additional permissions included in the custom role.
2+
3+
{% data reusables.organizations.mixed-roles-warning %}
4+
5+
To resolve conflicting access, you can adjust your organization's base permissions or the team's access, or edit the custom role. For more information, see:
6+
* "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/setting-base-permissions-for-an-organization)"
7+
* "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)"
8+
* "[Editing a repository role](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization#editing-a-repository-role)"{% ifversion custom-org-roles %}
9+
* "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-organization-roles#editing-a-custom-role)"{% endif %}

0 commit comments

Comments
 (0)