Fix: preserve symlinks in ZipArchive compress function #8250
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
sphanley
requested review from
bnbarham,
MaxDesiatov,
jakepetroules,
francescomikulis,
xedin,
dschaefer2,
shawnhyam,
bripeticca,
plemarquand,
owenv and
bkhouri
as code owners
|
@swift-ci test |
MaxDesiatov
added
bug
registry
MaxDesiatov
approved these changes
Jan 27, 2025
|
Thanks for the review, @MaxDesiatov! Apologies for the failing test on Linux, I'll try to dig into what's going on there and make sure this works cross-platform. |
|
@MaxDesiatov, I believe I've got this working– there's an issue that seems specific to Ubuntu 20.04 when the symlink in the unit test is at the root of the test's temp directory, but moving it to a subdirectory seems to behave correctly across MacOS and Linux and provides the same coverage for the functionality. |
|
@swift-ci test |
|
I hate to be a bother, but any chance someone can re-invoke the tests? Looks like the Windows job never reported its status, but I believe the tests should have passed. |
|
@swift-ci test Windows |
jakepetroules
approved these changes
Feb 5, 2025
|
Thanks! |
bripeticca
pushed a commit
to bripeticca/swift-package-manager
that referenced
this pull request
Feb 28, 2025
This PR fixes swiftlang#8248, by adding the `y` flag to the `zip` command that is executed when archiving a package's sources for publication to a registry on a non-Windows OS. ### Motivation: Without this change, packages which contain symlinks in their sources will produce invalid and potentially non-buildable archives when publishing to a registry, since any symlinks are currently transformed into duplicate files during the archive creation, instead of being preserved. ### Modifications: I've added the following flag to the `zip` call: > -y store symbolic links as the link instead of the referenced file I've additionally modified the associated `testCompress()` test case, adding logic to ensure that symlinks are preserved correctly. ### Result: With this change, the resulting zipfile that is uploaded to a registry will contain symlinks consistent with the original package sources.
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.
This PR fixes #8248, by adding the
yflag to thezipcommand that is executed when archiving a package's sources for publication to a registry on a non-Windows OS.Motivation:
Without this change, packages which contain symlinks in their sources will produce invalid and potentially non-buildable archives when publishing to a registry, since any symlinks are currently transformed into duplicate files during the archive creation, instead of being preserved.
Modifications:
I've added the following flag to the
zipcall:I've additionally modified the associated
testCompress()test case, adding logic to ensure that symlinks are preserved correctly.Result:
With this change, the resulting zipfile that is uploaded to a registry will contain symlinks consistent with the original package sources.