Repository navigation
[core] Share DefaultGenerator's "file was written" step in one helper - #25695
Open
ChihweiLHBird wants to merge 1 commit into
Open
ChihweiLHBird wants to merge 1 commit into
ChihweiLHBird wants to merge 1 commit into
Conversation
DefaultGenerator repeated the same block after writing a file in eleven places (models, model tests and docs, APIs, API tests and docs, the three webhook copies, supporting files and the ignore file): add the file to the list of generated files and, unless this is a dry run, pass it to config.postProcessFile with its file type. Replace the copies with a private addGeneratedFile(files, written, fileType). generateVersionMetadata keeps its own block: it adds versionMetadataFile (new File(path)) to the list rather than the File the template manager returns (Paths.get(path).toFile()), and the two are not guaranteed to be equal on every platform. postProcessFile had no test. Add two: one pins the file type passed for a model, an API and a supporting file, the other checks that nothing is post-processed on a dry run. No generated output changes.
ChihweiLHBird
force-pushed
the
refactor/default-generator-add-generated-file
branch
from
November 16, 2026 05:16
ae22e97 to
1b2a2d1
Compare
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Refactor only; no generated output changes.
DefaultGeneratorrepeated the same block in eleven places after writing a file: add it to the list of generated files and, unless this is a dry run, pass it toconfig.postProcessFilewith its file type. This replaces those copies with a privateaddGeneratedFile(files, written, fileType).PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
Summary by cubic
Refactors
DefaultGeneratorso the "file was written" step (adding the file to the generated list and callingpostProcessFileunless it's a dry run) lives in a single privateaddGeneratedFilehelper instead of being duplicated across eleven call sites. ThegenerateVersionMetadatapath keeps its own block because it tracks a differentFileinstance. No generated output changes. Adds two tests: one verifying the file type passed topostProcessFilefor models, APIs, and supporting files, and one confirmingpostProcessFileis skipped during dry runs.Written for commit 1b2a2d1. Summary will update on new commits.