Skip to content

feat(internal/librarian/java): add extractSnippets for README generation - #6597

Closed
yangyzs wants to merge 6 commits into
googleapis:mainfrom
yangyzs:feat/java-readme-extract-snippets
Closed

feat(internal/librarian/java): add extractSnippets for README generation#6597
yangyzs wants to merge 6 commits into
googleapis:mainfrom
yangyzs:feat/java-readme-extract-snippets

Conversation

@yangyzs

@yangyzs yangyzs commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Note: This pull request builds on top of #6593 and #6592. Please review and merge those first.

Add extractSnippets main function to collect sample files, extract code snippets, and trim leading whitespace across a directory. Add unit tests in readme_test.go.

For #6515

yangyzs added 5 commits June 30, 2026 13:20
…README

Add minLeadingSpaces and trimLeadingWhitespace helper functions to calculate
and normalize code snippet indentation for README block rendering. Add unit
tests in readme_test.go.

For googleapis#6515
…r README rendering

Add collectSnippetFiles and extractSnippetsFromFile helpers to scan Java
and XML sample files for code snippets. Add unit tests in readme_test.go.

For googleapis#6515
Add extractSnippets main function to collect sample files,
extract code snippets, and trim leading whitespace across a directory.
Add unit tests in readme_test.go.

For googleapis#6515
@yangyzs
yangyzs requested a review from a team as a code owner June 30, 2026 20:34

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces functionality to recursively scan, extract, and trim tagged code snippets from Java and XML files within a samples directory, along with comprehensive unit tests. The reviewer suggests using strings.Split instead of bufio.NewScanner when parsing files to prevent potential silent data loss if any line exceeds the default token limit.

Comment thread internal/librarian/java/readme.go
Signed-off-by: yangyzs <171981480+yangyzs@users.noreply.github.com>
@yangyzs
yangyzs requested a review from JoeWang1127 July 1, 2026 19:04
@JoeWang1127

Copy link
Copy Markdown
Contributor

We discussed about this pull request offline. We think the logic to fetch pom settings from snippets is complex thus hard to maintain.

We should render the pom settings in README.md via templating. This part is the same across all README.md after monorepo migration.

@blakeli0

blakeli0 commented Jul 2, 2026

Copy link
Copy Markdown

We discussed about this pull request offline. We think the logic to fetch pom settings from snippets is complex thus hard to maintain.

We should render the pom settings in README.md via templating. This part is the same across all README.md after monorepo migration.

Agreed. Separately, I created #6619 to track the golden tests idea we discussed offline.

@yangyzs
yangyzs marked this pull request as draft July 5, 2026 23:18
@yangyzs
yangyzs removed request for a team and JoeWang1127 July 5, 2026 23:19
@yangyzs yangyzs closed this Jul 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants