-
Notifications
You must be signed in to change notification settings - Fork 18
refactor: only send single plan comment to release pr #1009
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
Merged
Merged
Changes from all commits
Commits
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
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
200 changes: 200 additions & 0 deletions
200
apps/workspace-engine/svc/controllers/deploymentplan/github_comment.go
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,200 @@ | ||
| package deploymentplan | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/google/go-github/v66/github" | ||
| "github.com/google/uuid" | ||
| "go.opentelemetry.io/otel/attribute" | ||
| "go.opentelemetry.io/otel/codes" | ||
| "workspace-engine/pkg/config" | ||
| "workspace-engine/pkg/db" | ||
| gh "workspace-engine/pkg/github" | ||
| ) | ||
|
|
||
| const ( | ||
| metaGitHubOwner = "github/owner" | ||
| metaGitHubRepo = "github/repo" | ||
| metaGitSHA = "git/sha" | ||
| ) | ||
|
|
||
| func planCommentMarker(planID uuid.UUID) string { | ||
| return fmt.Sprintf("<!-- ctrlplane-plan:%s -->", planID) | ||
| } | ||
|
|
||
| func buildPlanCommentBody( | ||
| marker, baseURL, workspaceSlug string, | ||
| plan db.DeploymentPlan, | ||
| ) string { | ||
| planURL := fmt.Sprintf( | ||
| "%s/%s/deployments/%s/plans/%s", | ||
| strings.TrimRight(baseURL, "/"), | ||
| workspaceSlug, | ||
| plan.DeploymentID, | ||
| plan.ID, | ||
| ) | ||
|
|
||
| var sb strings.Builder | ||
| sb.WriteString(marker) | ||
| sb.WriteString("\n") | ||
| sb.WriteString("### Ctrlplane Deployment Plan\n\n") | ||
| fmt.Fprintf(&sb, "**Version:** `%s`\n\n", plan.VersionTag) | ||
| fmt.Fprintf(&sb, "[View plan →](%s)\n", planURL) | ||
| return sb.String() | ||
|
Comment on lines
+27
to
+45
|
||
| } | ||
|
|
||
| // MaybeCommentPlanLink posts or updates a PR comment linking to the plan | ||
| // detail page. It requires the following keys in plan.VersionMetadata: | ||
| // | ||
| // - "github/owner" — GitHub repository owner | ||
| // - "github/repo" — GitHub repository name | ||
| // - "git/sha" — commit SHA used to find the associated PR | ||
| // | ||
| // Returns nil (no-op) if any key is missing, the GitHub bot is not | ||
| // configured, or no PR is found for the SHA. | ||
| func MaybeCommentPlanLink( | ||
| ctx context.Context, | ||
| plan db.DeploymentPlan, | ||
| workspaceSlug string, | ||
| ) error { | ||
| ctx, span := tracer.Start(ctx, "MaybeCommentPlanLink") | ||
| defer span.End() | ||
|
|
||
| span.SetAttributes(attribute.String("plan_id", plan.ID.String())) | ||
|
|
||
| owner := plan.VersionMetadata[metaGitHubOwner] | ||
| repo := plan.VersionMetadata[metaGitHubRepo] | ||
| sha := plan.VersionMetadata[metaGitSHA] | ||
|
|
||
| span.SetAttributes( | ||
| attribute.String("github.owner", owner), | ||
| attribute.String("github.repo", repo), | ||
| attribute.String("git.sha", sha), | ||
| ) | ||
|
|
||
| if owner == "" || repo == "" || sha == "" { | ||
| span.AddEvent("skipped: missing github metadata") | ||
| return nil | ||
| } | ||
|
|
||
| client, err := gh.CreateClientForRepo(ctx, owner, repo) | ||
| if err != nil { | ||
| span.RecordError(err) | ||
| span.SetStatus(codes.Error, "create github client") | ||
| return fmt.Errorf("create github client: %w", err) | ||
| } | ||
| if client == nil { | ||
| span.AddEvent("skipped: github bot not configured") | ||
| return nil | ||
| } | ||
|
|
||
| prNumber, err := findPRForSHA(ctx, client, owner, repo, sha) | ||
| if err != nil { | ||
| span.RecordError(err) | ||
| span.SetStatus(codes.Error, "find PR for SHA") | ||
| return fmt.Errorf("find PR for SHA %s: %w", sha, err) | ||
| } | ||
| if prNumber == 0 { | ||
| span.AddEvent("skipped: no PR found for SHA") | ||
| return nil | ||
| } | ||
| span.SetAttributes(attribute.Int("github.pr_number", prNumber)) | ||
|
|
||
| marker := planCommentMarker(plan.ID) | ||
| body := buildPlanCommentBody(marker, config.Global.BaseURL, workspaceSlug, plan) | ||
|
|
||
| if err := upsertPlanComment(ctx, client, owner, repo, prNumber, marker, body); err != nil { | ||
| span.RecordError(err) | ||
| span.SetStatus(codes.Error, "upsert comment") | ||
| return fmt.Errorf("upsert comment on PR #%d: %w", prNumber, err) | ||
| } | ||
|
|
||
| span.AddEvent("comment upserted") | ||
| return nil | ||
| } | ||
|
|
||
| func findPRForSHA( | ||
| ctx context.Context, | ||
| client *github.Client, | ||
| owner, repo, sha string, | ||
| ) (int, error) { | ||
| prs, _, err := client.PullRequests.ListPullRequestsWithCommit( | ||
| ctx, owner, repo, sha, &github.ListOptions{PerPage: 1}, | ||
| ) | ||
| if err != nil { | ||
| return 0, fmt.Errorf("list PRs for commit %s: %w", sha, err) | ||
| } | ||
| for _, pr := range prs { | ||
| if pr.GetState() == "open" { | ||
| return pr.GetNumber(), nil | ||
| } | ||
| } | ||
| if len(prs) > 0 { | ||
| return prs[0].GetNumber(), nil | ||
| } | ||
| return 0, nil | ||
| } | ||
|
|
||
| func findMarkerComment( | ||
| ctx context.Context, | ||
| client *github.Client, | ||
| owner, repo string, | ||
| prNumber int, | ||
| marker string, | ||
| ) (*github.IssueComment, error) { | ||
| opts := &github.IssueListCommentsOptions{ | ||
| ListOptions: github.ListOptions{PerPage: 100}, | ||
| } | ||
| for { | ||
| comments, resp, err := client.Issues.ListComments( | ||
| ctx, owner, repo, prNumber, opts, | ||
| ) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("list comments: %w", err) | ||
| } | ||
| for _, c := range comments { | ||
| if strings.Contains(c.GetBody(), marker) { | ||
| return c, nil | ||
| } | ||
| } | ||
| if resp.NextPage == 0 { | ||
| return nil, nil | ||
| } | ||
| opts.Page = resp.NextPage | ||
| } | ||
| } | ||
|
|
||
| func upsertPlanComment( | ||
| ctx context.Context, | ||
| client *github.Client, | ||
| owner, repo string, | ||
| prNumber int, | ||
| marker, body string, | ||
| ) error { | ||
| existing, err := findMarkerComment(ctx, client, owner, repo, prNumber, marker) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if existing != nil { | ||
| _, _, err := client.Issues.EditComment( | ||
| ctx, owner, repo, existing.GetID(), | ||
| &github.IssueComment{Body: &body}, | ||
| ) | ||
| if err != nil { | ||
| return fmt.Errorf("edit comment: %w", err) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| _, _, err = client.Issues.CreateComment( | ||
| ctx, owner, repo, prNumber, | ||
| &github.IssueComment{Body: &body}, | ||
| ) | ||
| if err != nil { | ||
| return fmt.Errorf("create comment: %w", err) | ||
| } | ||
| return nil | ||
| } | ||
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
Oops, something went wrong.
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.
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.
commentPlanLinkalways queriesGetWorkspaceByIDeven when PR commenting will be a no-op (e.g., missinggithub/owner/github/repo/git/shainplan.VersionMetadataor when the GitHub bot isn’t configured). This adds an extra DB round-trip per plan unnecessarily. Consider short-circuiting before the workspace lookup when the required metadata/bot config is absent, and only fetching the workspace slug when you’re actually going to attempt the GitHub upsert.