Add DEFAULT_VALUE_CHANGED to configuration metadata changelog #48962
+73
−3
Conversation
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
Detect when configuration property default values have changed between versions. This allows users to be notified of changes that might affect their application's behavior without any code changes on their part. Closes spring-projectsgh-47505 Signed-off-by: junpak <junpak.park@gmail.com>
Add a new section at the top of the configuration properties changelog to display properties whose default values have changed. This helps users identify changes that might affect their application's behavior. The section displays the property key, old default value, and new default value in a table format. Signed-off-by: junpak <junpak.park@gmail.com>
Verify that default value changes are detected correctly for array properties. The JSON parser produces ArrayList instances which support equality comparison via Objects.equals(). Signed-off-by: junpak <junpak.park@gmail.com>
spring-projects-issues
added
the
status: waiting-for-triage
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
DEFAULT_VALUE_CHANGEDtype toDifferenceTypeenumRelated Issue
Closes gh-47505
Changed Files
DifferenceType.javaDEFAULT_VALUE_CHANGEDenumDifference.javacompute()ChangelogWriter.javaChangelogTests.javasample-*.json,sample.adocTests
ChangelogTests- Verified DEFAULT_VALUE_CHANGED detectionChangelogWriterTests- Verified new section rendering./gradlew :configuration-metadata:spring-boot-configuration-metadata-changelog-generator:checkpassedDiscussion
I have asked the maintainers about how to handle cases where both deprecation and defaultValue changes occur simultaneously.
Currently implemented to display in both sections (Option 1).