Provision Sourcery via SwiftPM instead of CocoaPods #15609
Merged
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
Collaborator
|
|
mokagio
added
the
category: tooling
mokagio
commented
May 9, 2025
| @@ -1,6 +1,168 @@ | |||
| { | |||
| "originHash" : "cd02791f9079102404056ed65d89c5c6bb997332bbfd1b03550dfdd51e57551e", | |||
| "originHash" : "bb374fb1cfe6769494b51a8da522b904ded4d3987ad68cd369eadb59e59f5e74", | |||
Contributor
Author
There was a problem hiding this comment.
Lots of dependencies coming via Sourcery. Luckily none of those affect the app.
mokagio
commented
May 9, 2025
Comment on lines
-146
to
+145
| %w[Hardware Networking Storage Yosemite WooCommerce WooFoundation].each do |prefix| | ||
| puts "\n\nGenerating Copiable for #{prefix}..." | ||
| puts '=' * 100 | ||
|
|
||
| sh "./Pods/Sourcery/bin/sourcery --config CodeGeneration/Sourcery/Copiable/#{prefix}-Copiable.sourcery.yaml" | ||
| end | ||
|
|
||
| puts "\n\nDONE. Generated Copiable for all projects." | ||
|
|
||
| %w[Hardware Networking Yosemite WooFoundation].each do |prefix| | ||
| puts "\n\nGenerating Fakes for #{prefix}..." | ||
| puts '=' * 100 | ||
|
|
||
| sh "./Pods/Sourcery/bin/sourcery --config CodeGeneration/Sourcery/Fakes/#{prefix}-Fakes.yaml" | ||
| end | ||
|
|
||
| puts "\n\nDONE. Generated Fakes." | ||
| # See note in BuildTools/.sourcery.yml for why we call without arguments | ||
| run_package_plugin(cmd: 'sourcery-command') |
Contributor
Author
There was a problem hiding this comment.
For some reason, when running via Swift package plugin, Sourcery ignores the --config parameter and only reads from .sourcery.yml
Luckily, one can configure everything in .sourcery.yml (see below).
I think in the end that's a better approach. We don't need to loop through folders of look for files. The tool does it all for us.
mokagio
commented
May 9, 2025
| 3F0904022D26A40800D8ACCE /* WordPressAuthenticator */ = {isa = PBXFileSystemSynchronizedRootGroup; exceptions = (3F09041C2D26A40800D8ACCE /* PBXFileSystemSynchronizedBuildFileExceptionSet */, ); explicitFileTypes = {}; explicitFolders = (); path = WordPressAuthenticator; sourceTree = "<group>"; }; | ||
| 3F09040E2D26A40800D8ACCE /* WordPressAuthenticatorTests */ = {isa = PBXFileSystemSynchronizedRootGroup; exceptions = (3FD28D5E2D271391002EBB3D /* PBXFileSystemSynchronizedBuildFileExceptionSet */, ); explicitFileTypes = {}; explicitFolders = (); path = WordPressAuthenticatorTests; sourceTree = "<group>"; }; | ||
| 3F0904022D26A40800D8ACCE /* WordPressAuthenticator */ = { | ||
| isa = PBXFileSystemSynchronizedRootGroup; |
Contributor
Author
There was a problem hiding this comment.
All these are generated by CocoaPods / Xcode 16.3 — See also #15608
Contributor
|
Note: Failing unit test is unrelated and fixed here. |
staskus
approved these changes
May 9, 2025
Contributor
staskus
left a comment
staskus
left a comment
There was a problem hiding this comment.
Thanks! Sourcery code gen continue to work 👍
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.
Description
This is part of the ongoing work to move away from CocoaPods, https://linear.app/a8c/issue/AINFRA-216.
#15598 established a
BuildToolsfolder with a Swift package dedicated to dependencies that we only use as tools—i.e. not imported in the code base.Sourcery is one such dependency and this PR moves it to be provisioned via SwiftPM instead of CocoaPods.
See also https://linear.app/a8c/issue/AINFRA-404.
Steps to reproduce & Testing information
To verify the change works, checkout the branch and run
bundle exec rake generate. You'll see SwiftPM fetching all the Sourcery dependencies and after that running the binary to generate the various Swift files from the Sourcery templates. Because the templates have not changed ,there should be no additional change in your local repo.To verify Sourcery actually can generate update files, modify one of the two templates:
CodeGeneration/Sourcery/Copiable/Models+Copiable.swifttemplateCodeGeneration/Sourcery/Fakes/Fakes.swifttemplateand verify the updated files are consistent with the changes you made. Example:
Template change
Generated changes
Screenshots
RELEASE-NOTES.txtif necessary.Reviewer (or Author, in the case of optional code reviews):
Please make sure these conditions are met before approving the PR, or request changes if the PR needs improvement: