From 518205c34bcf5897119d0e085fbe3c0530f853fc Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Thu, 1 Sep 2022 11:12:56 +0200 Subject: [PATCH 1/5] adds note and versioning --- ...-custom-repository-roles-for-an-organization.md | 14 +++++++++++++- data/features/custom-repo-role-api.yml | 6 ++++++ .../organizations/custom-repo-role-api-beta.md | 6 ++++++ 3 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 data/features/custom-repo-role-api.yml create mode 100644 data/reusables/organizations/custom-repo-role-api-beta.md diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md index 6c6b534015..4292ef785a 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md @@ -18,7 +18,19 @@ To perform any actions on {% data variables.product.product_name %}, such as cre Within an organization, you can assign roles at the organization, team, and repository level. For more information about the different levels of roles, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." -You can have more granular control over the permissions you grant at the repository level by creating up to three custom repository roles. A custom repository role is a configurable set of permissions with a custom name you choose. After you create a custom role, anyone with admin access to a repository can assign the role to an individual or team. For more information, see "[Managing an individual's access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-an-individuals-access-to-an-organization-repository)" and "[Managing team access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)" +You can have more granular control over the permissions you grant at the repository level by creating up to three custom repository roles. A custom repository role is a configurable set of permissions with a custom name you choose. After you create a custom role, anyone with admin access to a repository can assign the role to an individual or team. For more information, see "[Managing an individual's access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-an-individuals-access-to-an-organization-repository)" and "[Managing team access to an organization repository](/organizations/managing-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)." + +{% ifversion custom-repo-role-api %} + +You can also use the REST API to manage custom repository roles. For more information, see "[Custom Repository Roles API](/rest/orgs/custom-roles)." + +{% data reusables.organizations.custom-repo-role-api-beta %} + +{% else %} + +You can also use the REST API to list the custom repository roles available in your organization. For more information, see "[Custom Repository Roles API](/rest/orgs/custom-roles)." + +{% endif %} ## About the inherited role diff --git a/data/features/custom-repo-role-api.yml b/data/features/custom-repo-role-api.yml new file mode 100644 index 0000000000..098729a4f4 --- /dev/null +++ b/data/features/custom-repo-role-api.yml @@ -0,0 +1,6 @@ +# Issue 7793 +# Custom Repo Roles Management API +versions: + ghec: '*' + ghes: '>=3.8' + ghae: 'issue-7793' diff --git a/data/reusables/organizations/custom-repo-role-api-beta.md b/data/reusables/organizations/custom-repo-role-api-beta.md new file mode 100644 index 0000000000..c89d0559f9 --- /dev/null +++ b/data/reusables/organizations/custom-repo-role-api-beta.md @@ -0,0 +1,6 @@ + +{% note %} + +**Note:** The custom repository roles API is currently in public beta and subject to change. + +{% endnote %} \ No newline at end of file From 53a38695558699a702cd8921efd6d1a12b668a09 Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Thu, 1 Sep 2022 14:15:59 +0200 Subject: [PATCH 2/5] adds caps --- data/reusables/organizations/custom-repo-role-api-beta.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/reusables/organizations/custom-repo-role-api-beta.md b/data/reusables/organizations/custom-repo-role-api-beta.md index c89d0559f9..669bb9f5f1 100644 --- a/data/reusables/organizations/custom-repo-role-api-beta.md +++ b/data/reusables/organizations/custom-repo-role-api-beta.md @@ -1,6 +1,6 @@ {% note %} -**Note:** The custom repository roles API is currently in public beta and subject to change. +**Note:** The Custom Repository Roles API is currently in public beta and subject to change. {% endnote %} \ No newline at end of file From 936293a7fc376a1000dc1709b926f4eda89aa307 Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Fri, 2 Sep 2022 13:51:05 +0200 Subject: [PATCH 3/5] Apply suggestions from code review Co-authored-by: Sarah Edwards --- .../managing-custom-repository-roles-for-an-organization.md | 2 +- data/reusables/organizations/custom-repo-role-api-beta.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md index 4292ef785a..3bab81d819 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md @@ -22,7 +22,7 @@ You can have more granular control over the permissions you grant at the reposit {% ifversion custom-repo-role-api %} -You can also use the REST API to manage custom repository roles. For more information, see "[Custom Repository Roles API](/rest/orgs/custom-roles)." +You can also use the REST API to manage custom repository roles. For more information, see "[Custom Repository Roles](/rest/orgs/custom-roles)." {% data reusables.organizations.custom-repo-role-api-beta %} diff --git a/data/reusables/organizations/custom-repo-role-api-beta.md b/data/reusables/organizations/custom-repo-role-api-beta.md index 669bb9f5f1..01f8533be3 100644 --- a/data/reusables/organizations/custom-repo-role-api-beta.md +++ b/data/reusables/organizations/custom-repo-role-api-beta.md @@ -1,6 +1,6 @@ {% note %} -**Note:** The Custom Repository Roles API is currently in public beta and subject to change. +**Note:** The Custom Repository Roles API is currently in beta and subject to change. {% endnote %} \ No newline at end of file From 31ece2c4ba41315f4d8a67668381f8f5584fdf8b Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Fri, 2 Sep 2022 15:14:56 +0200 Subject: [PATCH 4/5] removes beta note as it's already present in the API docs --- .../managing-custom-repository-roles-for-an-organization.md | 2 -- data/reusables/organizations/custom-repo-role-api-beta.md | 6 ------ 2 files changed, 8 deletions(-) delete mode 100644 data/reusables/organizations/custom-repo-role-api-beta.md diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md index 3bab81d819..6dc53cf84d 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md @@ -24,8 +24,6 @@ You can have more granular control over the permissions you grant at the reposit You can also use the REST API to manage custom repository roles. For more information, see "[Custom Repository Roles](/rest/orgs/custom-roles)." -{% data reusables.organizations.custom-repo-role-api-beta %} - {% else %} You can also use the REST API to list the custom repository roles available in your organization. For more information, see "[Custom Repository Roles API](/rest/orgs/custom-roles)." diff --git a/data/reusables/organizations/custom-repo-role-api-beta.md b/data/reusables/organizations/custom-repo-role-api-beta.md deleted file mode 100644 index 01f8533be3..0000000000 --- a/data/reusables/organizations/custom-repo-role-api-beta.md +++ /dev/null @@ -1,6 +0,0 @@ - -{% note %} - -**Note:** The Custom Repository Roles API is currently in beta and subject to change. - -{% endnote %} \ No newline at end of file From 1f7d6cc75b18286b07754681731c4c227f63608d Mon Sep 17 00:00:00 2001 From: Sophie <29382425+sophietheking@users.noreply.github.com> Date: Mon, 5 Sep 2022 10:02:52 +0200 Subject: [PATCH 5/5] Update content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md Co-authored-by: Hirsch Singhal <1666363+hpsin@users.noreply.github.com> --- .../managing-custom-repository-roles-for-an-organization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md index 6dc53cf84d..cc6ec18ba9 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization.md @@ -22,7 +22,7 @@ You can have more granular control over the permissions you grant at the reposit {% ifversion custom-repo-role-api %} -You can also use the REST API to manage custom repository roles. For more information, see "[Custom Repository Roles](/rest/orgs/custom-roles)." +You can also use the REST API to create and manage custom repository roles. For more information, see "[Custom Repository Roles](/rest/orgs/custom-roles)." {% else %}