Skip to content

Fix detailed reviewers formatting #53

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
BakerNet merged 6 commits into from
Jul 3, 2025
Merged

Fix detailed reviewers formatting #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c313415
Fix formatting of detailed reviewers list
BakerNet Jul 3, 2025
8734cac
Fix test
BakerNet Jul 3, 2025
2e83c41
Gemini review
BakerNet Jul 3, 2025
7d990f3
Covbadge
BakerNet Jul 3, 2025
add5352
Fix flaky test and guarantee output order
BakerNet Jul 3, 2025
2a475d9
Covbadge
BakerNet Jul 3, 2025
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
14 changes: 10 additions & 4 deletions internal/app/app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,9 +315,7 @@ func (a *App) addReviewStatusComment(allRequiredOwners codeowners.ReviewerGroups
}

if a.Conf.DetailedReviewers {
comment += "\n\n<details><summary>Show detailed file reviewers</summary>\n"
comment += a.getFileOwnersMapToString(a.codeowners.FileRequired())
comment += "</details>"
comment += fmt.Sprintf("\n\n<details><summary>Show detailed file reviewers</summary>\n\n%s\n</details>", a.getFileOwnersMapToString(a.codeowners.FileRequired()))
}

fiveDaysAgo := time.Now().AddDate(0, 0, -5)
Expand Down Expand Up @@ -461,7 +459,15 @@ func (a *App) printFileOwners(codeOwners codeowners.CodeOwners) {

func (a *App) getFileOwnersMapToString(fileReviewers map[string]codeowners.ReviewerGroups) string {
builder := strings.Builder{}
for file, reviewers := range fileReviewers {

files := make([]string, 0, len(fileReviewers))
for file := range fileReviewers {
files = append(files, file)
}
slices.Sort(files)

for _, file := range files {
reviewers := fileReviewers[file]
// builder.WriteString error return is always nil
_, _ = fmt.Fprintf(&builder, "- %s: %+v\n", file, reviewers.Flatten())
}
Expand Down
5 changes: 3 additions & 2 deletions internal/app/app_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1228,13 +1228,14 @@ func TestCommentDetailedReviewers(t *testing.T) {
t.Errorf("unexpected error: %v", err)
}

DetailedReviewersSnippet := "\n\n<details><summary>Show detailed file reviewers</summary>\n" +
DetailedReviewersSnippet := "\n\n<details><summary>Show detailed file reviewers</summary>\n\n" +
"- file1.go: [@user1 @user2]\n" +
"- file2.go: [@user1]\n"
"- file2.go: [@user1]\n\n"

containsDetailedReviewersSnippet := strings.Contains(mockGH.AddCommentInput, DetailedReviewersSnippet)

if tc.detailedReviewers != containsDetailedReviewersSnippet {
t.Logf("AddCommentInput: %s", mockGH.AddCommentInput)
t.Errorf("expected comment to include detailed owners to be %t, got %t ",
tc.detailedReviewers, containsDetailedReviewersSnippet)
}
Expand Down
Loading