You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/guides/github-app-authentication.md
+23-4Lines changed: 23 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,11 +33,30 @@ jobs:
33
33
The root reusable workflow forwards these two values to the Plan, Build-Module, and Publish-Module reusable jobs.
34
34
Do not use `secrets: inherit` as a substitute for this mapping.
35
35
36
-
For Dependabot pull requests, create `SHELLY_CLIENT_ID` and `SHELLY_PRIVATE_KEY` as Dependabot secrets as well as
37
-
Actions secrets. Dependabot-triggered workflows cannot read regular Actions secrets, so the GitHub App token cannot
38
-
be minted without separate Dependabot secret values.
36
+
Dependabot-triggered workflows cannot read regular Actions secrets. Do not duplicate Shelly's private key into
37
+
Dependabot secrets by default: a compromised dependency update could alter workflow code that receives the key before
38
+
human review. If an organization requires the Process-PSModule workflow to run on Dependabot pull requests, its
39
+
security owners must explicitly accept that trust boundary and provision separate Dependabot secrets. Otherwise,
40
+
skip token-consuming jobs for Dependabot pull requests and run the full workflow after review or merge.
39
41
40
-
## Token scope
42
+
## GitHub App installation permissions
43
+
44
+
Install Shelly only on repositories that the process must manage. The complete permission baseline for the current
45
+
Process-PSModule GitHub App path is:
46
+
47
+
| Repository permission | Access | Why it is needed |
48
+
| --- | --- | --- |
49
+
| Contents | Write | Read releases during version resolution; create, upload to, and delete releases during publish and cleanup. |
50
+
| Pull requests | Write | Read pull-request files and labels; add process and release comments to pull requests. |
51
+
| Metadata | Read | Read repository description, topics, and URL while building the module manifest. This permission is granted automatically to GitHub Apps. |
52
+
53
+
Do not grant Shelly Actions, Issues, Statuses, Pages, Workflows, or administration permissions for the current
54
+
Process-PSModule GitHub App path. Those permissions are not used by installation tokens minted here.
55
+
56
+
The caller workflow's `permissions:` block is separate: it scopes only `github.token` for non-App operations such as
57
+
artifact handling, linting, and Pages deployment. It cannot expand or restrict Shelly's installation token.
58
+
59
+
## Per-workflow token scope
41
60
42
61
Each job mints its own token with the repository that triggered the workflow:
0 commit comments