Make the output of PropertiesFileTransformer reproducible
#1861
+172
−75
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
Contributor
Author
|
Depends on #1856 |
snazy
force-pushed
the
pft-reproducible
branch
from
751dddc to
64714f4
Compare
snazy
force-pushed
the
pft-reproducible
branch
from
64714f4 to
1bcd72c
Compare
Goooler
reviewed
Nov 18, 2025
src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/internal/ReproducibleProperties.kt
Outdated
Show resolved
Hide resolved
`PropertiesFileTransformer` leverages `java.util.Properties`, which relies on `java.util.Hashtable`. The serialized properties are not guaranteed to be reproducible. This change changes the transformer to use a sorted map to generate reproducible output. The existing class `CleanProperties` is replaced with `ReproducibleProperties`. Functionality around charset handling is retained, and extended with a functionality to generate unicode escapes (ASCII output).
snazy
force-pushed
the
pft-reproducible
branch
2 times, most recently
from
30d2084 to
f7c0b62
Compare
Contributor
Author
|
Okay, GH is broken :( |
Member
|
Let's wait to tomorrow 😁 |
snazy
force-pushed
the
pft-reproducible
branch
from
f7c0b62 to
2a77ea6
Compare
Contributor
Author
|
Oh, it's the "zulu" installer that barks. |
snazy
force-pushed
the
pft-reproducible
branch
from
b700d69 to
2a77ea6
Compare
Goooler
force-pushed
the
pft-reproducible
branch
2 times, most recently
from
f53e3ed to
8871cd9
Compare
Goooler
changed the title
PropertiesFileTransformer - make merged properties reproduciblePropertiesFileTransformer reproducible
Goooler
force-pushed
the
pft-reproducible
branch
from
8871cd9 to
87e0a2c
Compare
Copilot finished reviewing on behalf of
Goooler
November 19, 2025 02:15
Goooler
approved these changes
Nov 19, 2025
| }.toString().reader().buffered() | ||
|
|
||
| private val String?.couldBeCommentWithTimestamp: Boolean get() { | ||
| return this != null && startsWith("#") && length == lengthOfExpectedTimestamp |
Member
There was a problem hiding this comment.
The old logic is useful for removing date comments only. All comments are removed in this PR. See Goooler#102 (comment).
I'm considering whether we should introduce a new property to opt for the feature in. The new flag will control:
- Remove all comments or not.
- Sort all properties or not.
Contributor
Author
There was a problem hiding this comment.
Member
There was a problem hiding this comment.
The comment was always empty
You are right!
add a new comment...
Let's keep the current behavior; otherwise, we need to add comments for the property-related transformers.
Member
|
I reverted the name change of |
This was referenced Nov 19, 2025
Member
|
Addressing the renaming to #1869. |
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.
PropertiesFileTransformerleveragesjava.util.Properties, which relies onjava.util.Hashtable. The serialized properties are not guaranteed to be reproducible.This change changes the transformer to use a sorted map to generate reproducible output. The existing class
CleanPropertiesis replaced withReproducibleProperties.Functionality around charset handling is retained, and extended with a functionality to generate unicode escapes (ASCII output).
Refs #1848.