Skip to content

fix(settings): surface missing pull_requests:read in settings preview #508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JSONbored merged 1 commit into from
Jun 10, 2026
Merged

fix(settings): surface missing pull_requests:read in settings preview #508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/signals/settings-preview.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,6 +494,7 @@ function activeMissingPermissions(settings: RepositorySettings, decision: Public
if (!installation) return [];
const missing = new Set(installation.missingPermissions);
const active: string[] = [];
if (missing.has("pull_requests")) active.push("pull_requests");
// Comment/label output is gated on issues:write (Issues endpoints), not pull_requests:write.
if (writesPrPublicSurface(settings, decision) && missing.has("issues")) active.push("issues");
if ((decision.willCheckRun || settings.checkRunMode === "enabled" || settings.gateCheckMode === "enabled") && missing.has("checks")) active.push("checks");
Expand Down
15 changes: 11 additions & 4 deletions test/unit/settings-preview.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,9 +166,10 @@ describe("buildRepoSettingsPreview", () => {
});
});

it("requires only pull_requests:read for PR comment/label output (no PR write overprivilege)", () => {
// Installation grants issues:write (everything comment/label output actually needs) but is missing
// pull_requests; the app only reads PRs, so this must NOT be flagged as a comment/label blocker.
it("reports missing pull_requests:read without requiring PR write for PR comment/label output", () => {
// Installation grants issues:write (everything comment/label output actually writes with) but is missing
// pull_requests:read, which the app still requires to read PRs. This must be reported without
// regressing to the previous overbroad pull_requests:write requirement.
const preview = buildRepoSettingsPreview({
...base,
settings: settings(),
Expand All @@ -177,7 +178,13 @@ describe("buildRepoSettingsPreview", () => {
});
expect(preview.installPreview.permissions.required).toContain("pull_requests: read");
expect(preview.installPreview.permissions.required).not.toContain("pull_requests: write");
expect(preview.installPreview.permissions.missing).not.toContain("pull_requests");
expect(preview.installPreview.permissions.missing).toContain("pull_requests");
expect(preview.installPreview.permissions.status).toBe("needs_attention");
expect(preview.installPreview.status).toBe("needs_attention");
expect(preview.installPreview.checklist.find((item) => item.id === "permissions")).toMatchObject({
status: "needs_attention",
summary: expect.stringContaining("pull_requests"),
});
});

it("explains a missing optional Checks: write permission only when check runs are enabled", () => {
Expand Down