Skip to content

fix(apidump): line-ending-agnostic API baseline comparison #54

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
monstercameron merged 1 commit into from
Jun 29, 2026
Merged

fix(apidump): line-ending-agnostic API baseline comparison #54

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
6 changes: 5 additions & 1 deletion internal/apidump/apidump.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,11 @@ func Check(parseT testing.TB, parseDir, parseGolden string) {
if parseErr != nil {
parseT.Fatalf("read golden %s (generate it with UPDATE_API_BASELINE=1): %v", parseGolden, parseErr)
}
if string(parseWant) != parseGot {
// Normalize line endings before comparing: the generated API uses "\n", but a golden file
// checked out on Windows (autocrlf) carries "\r\n", which would otherwise fail the comparison
// on every line despite identical content. This keeps the gate stable across platforms/checkouts.
parseWantNormalized := strings.ReplaceAll(string(parseWant), "\r\n", "\n")
if parseWantNormalized != parseGot {
parseT.Fatalf("public API of %s changed.\nIf intentional, regenerate with UPDATE_API_BASELINE=1 and review the diff.\n\n--- current API ---\n%s", parseDir, parseGot)
}
}
Loading