Skip to content

Commit 5986a44

Browse files
fix: Adjusting docs on all repos permissions (#2200)
* fix: Adjusting docs on all repos permissions * fix: Adjusting copy for all repos permissions * Another take at being very explicit about permissions (#2204) * Another take at being very explicit about permissions * fix: correct explanation for enterprise tokens * Update viagithubapp.md --------- Co-authored-by: Zach Goldberg <[email protected]>
1 parent ca43869 commit 5986a44

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/2.0/docs/pipelines/installation/viagithubapp.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,15 @@ As of 2024/09/10, the Gruntwork.io GitHub App requests the following permissions
3535

3636
Gruntwork.io requests all of these permissions because it requires them for different operations. Unfortunately, the way GitHub apps work prevents us from requesting permissions on a more granular basis. Know that the GitHub App Service will scope down its permissions whenever possible to the minimum required for the operation at hand.
3737

38-
The level of granularity available to customers when configuring the GitHub App installation is to either install the app on a per-repository basis or on an entire organization. Our recommendation is to install the app on the organization as a whole, as this will allow Gruntwork.io to do all it's meant to do. You should use your best judgement when deciding on this, however. If you are unsure, reach out to Gruntwork Support for guidance.
38+
The level of granularity available to customers when configuring the GitHub App installation is to either install the app on a per-repository basis or on an entire organization. Our recommendation is as follows:
39+
40+
* For non-enterprise customers, allow the app for `infrastructure-live-root` repository and (if in-use) `infrastructure-live-access-control` and `infrastructure-modules`.
41+
* For enterprise customers, allow the app to have access to the entire organization.
42+
43+
The reasoning for requiring entire-organization access for enterprise customers is that if you are using Account Factory to create delegated repositories then Account Factory will be creating, and then immediately modifying, new repositories in automated flows, which means it needs access to new repos as soon as they are created which is only possible with entire organization permission.
44+
45+
46+
If you are unsure how to proceed here, reach out to Gruntwork Support for guidance.
3947

4048
<h3>Read access to Actions</h3>
4149

0 commit comments

Comments
 (0)