-
Notifications
You must be signed in to change notification settings - Fork 421
feat(eve): add guided GitHub setup #1499
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.
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
Draft
OwenKephart
wants to merge
7
commits into
main
Choose a base branch
from
feat/github-guided-setup
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
6ffcb53
feat(eve): add guided GitHub setup
OwenKephart 337afae
feat(eve): configure GitHub webhook events during setup
vercel[bot] 7b7d22b
fix(eve): use GitHub events create flag
vercel[bot] 96ff29f
fix(eve): use repeatable trigger event flags
vercel[bot] f852a7a
refactor(eve): simplify guided setup presentation
OwenKephart 745178e
fix(eve): polish GitHub setup flow
OwenKephart 7a2ab9d
fix(eve): configure GitHub App mentions
OwenKephart File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "eve": patch | ||
| --- | ||
|
|
||
| Add guided GitHub channel setup through `eve add channel/github`. The flow provisions a Vercel Connect GitHub App, routes verified webhooks, scaffolds the channel, and explains how to install and use the app. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,6 @@ | ||
| import { connectGitHubCredentials } from "@vercel/connect/eve"; | ||
| import { githubChannel } from "eve/channels/github"; | ||
|
|
||
| export default githubChannel({ | ||
| credentials: { | ||
| appId: () => process.env.GITHUB_APP_ID!, | ||
| privateKey: () => process.env.GITHUB_APP_PRIVATE_KEY!, | ||
| webhookSecret: () => process.env.GITHUB_WEBHOOK_SECRET!, | ||
| }, | ||
| credentials: connectGitHubCredentials("github/my-agent"), | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
114 changes: 114 additions & 0 deletions
114
packages/eve/src/setup/integrations/github/connect.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| import { describe, expect, it, vi } from "vitest"; | ||
|
|
||
| import type { ChannelSetupLog } from "#setup/cli/index.js"; | ||
| import { parseCreatedGitHubConnector, provisionGitHubConnector } from "./connect.js"; | ||
|
|
||
| function log(): ChannelSetupLog { | ||
| return { | ||
| message: vi.fn(), | ||
| info: vi.fn(), | ||
| success: vi.fn(), | ||
| warning: vi.fn(), | ||
| error: vi.fn(), | ||
| commandOutput: vi.fn(), | ||
| }; | ||
| } | ||
|
|
||
| describe("GitHub Connect provisioning", () => { | ||
| it("parses an app-scoped GitHub connector", () => { | ||
| expect( | ||
| parseCreatedGitHubConnector( | ||
| JSON.stringify({ | ||
| id: "scl_github", | ||
| uid: "github/agent", | ||
| supportedSubjectTypes: ["app"], | ||
| }), | ||
| ), | ||
| ).toEqual({ id: "scl_github", uid: "github/agent" }); | ||
| }); | ||
|
|
||
| it("creates the connector and replaces its trigger", async () => { | ||
| const runVercelCaptureStdout = vi | ||
| .fn() | ||
| .mockResolvedValueOnce({ | ||
| ok: true as const, | ||
| stdout: JSON.stringify({ | ||
| id: "scl_github", | ||
| uid: "github/agent", | ||
| supportedSubjectTypes: ["app"], | ||
| }), | ||
| stderr: "", | ||
| }) | ||
| .mockResolvedValueOnce({ | ||
| ok: true as const, | ||
| stdout: JSON.stringify({ | ||
| data: { appSlug: "agent" }, | ||
| id: "scl_github", | ||
| type: "github", | ||
| uid: "github/agent", | ||
| }), | ||
| stderr: "", | ||
| }); | ||
| const runVercel = vi.fn(async () => true); | ||
|
|
||
| await expect( | ||
| provisionGitHubConnector({ | ||
| events: ["issue_comment", "pull_request_review_comment"], | ||
| log: log(), | ||
| project: { orgId: "team_123", projectId: "prj_123" }, | ||
| projectRoot: "/project", | ||
| slug: "agent", | ||
| deps: { runVercel, runVercelCaptureStdout }, | ||
| }), | ||
| ).resolves.toEqual({ appSlug: "agent", id: "scl_github", uid: "github/agent" }); | ||
|
|
||
| expect(runVercelCaptureStdout).toHaveBeenCalledWith( | ||
| [ | ||
| "connect", | ||
| "create", | ||
| "github", | ||
| "--name", | ||
| "agent", | ||
| "--triggers", | ||
| "--trigger-event", | ||
| "issue_comment", | ||
| "--trigger-event", | ||
| "pull_request_review_comment", | ||
| "-F", | ||
| "json", | ||
| "--scope", | ||
| "team_123", | ||
| ], | ||
| expect.objectContaining({ cwd: "/project", nonInteractive: true }), | ||
| ); | ||
| expect(runVercelCaptureStdout).toHaveBeenNthCalledWith( | ||
| 2, | ||
| ["api", "/v1/connect/connectors/scl_github", "--scope", "team_123", "--raw"], | ||
| expect.objectContaining({ cwd: "/project", nonInteractive: true }), | ||
| ); | ||
| expect(runVercel).toHaveBeenNthCalledWith( | ||
| 1, | ||
| ["connect", "detach", "github/agent", "--project", "prj_123", "--yes", "--scope", "team_123"], | ||
| expect.objectContaining({ cwd: "/project", nonInteractive: true }), | ||
| ); | ||
| expect(runVercel).toHaveBeenNthCalledWith( | ||
| 2, | ||
| [ | ||
| "connect", | ||
| "attach", | ||
| "github/agent", | ||
| "--project", | ||
| "prj_123", | ||
| "--environment", | ||
| "production", | ||
| "--triggers", | ||
| "--trigger-path", | ||
| "/eve/v1/github", | ||
| "--yes", | ||
| "--scope", | ||
| "team_123", | ||
| ], | ||
| expect.objectContaining({ cwd: "/project", nonInteractive: true }), | ||
| ); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
channel/githubguided-setup feature ships as apatch(→ 0.29.4) but its registry gate requires>=0.31.0, so the released version blocks users from running its own setup.