Support for Swift Packages #624

yonaskolb · 2019-08-13T12:06:04Z

This adds support for defining and linking to Swift Packages

packages:
  Yams:
    url: https://github.com/jpsim/Yams
    majorVersion: 2.0.0
  SwiftPM:
    url: https://github.com/apple/swift-package-manager
    branch: swift-5.0-branch
targets:
  App:
    dependencies:
      - package: Yams 
      - package: SwiftPM
        product: SPMUtility

See the ProjectSpec diff for more documentation https://github.com/yonaskolb/XcodeGen/pull/624/files#diff-938b5cf412212f1137a53f072512963a

Please test this out and report any issues.

One thing that is broken as of Xcode 11 beta 5 is that packages don't work if you are using configurations other than the default Debug and Release. That SPM bug is tracked here https://bugs.swift.org/browse/SR-10927

toshi0383

LGTM🙆‍♂️

brentleyjones

I'm going to pull this down and experiment with our project to see if everything is good. Looks good from review though.

brentleyjones · 2019-08-13T13:36:19Z

Docs/ProjectSpec.md

+## Swift Package
+Swift packages are defined at a project level, and then linked to individual targets via a [Dependency](#dependency).
+
+> Note that Swift Packages don't work in projects with configurations other than Debug and Release


Can we add a link to https://bugs.swift.org/browse/SR-10927?

mmmilo · 2019-08-13T14:00:20Z

Is it possible to allow for adding multiple products?

One use case is that I am looking to add a target that contains mock/test data.

Edit:
For example:

project.yml:

dependencies:
- package: SomeDependency
       product: [SomeDependency, SomeDependencyTestData]

Package.swift:

let package = Package(
    name: "SomeDependencyAPI",
    products: [
        .library(name: "SomeDependencyAPI", targets: ["SomeDependencyAPI"]),
        .library(name: "SomeDependencyAPITestData", targets: ["SomeDependencyAPITestData"]),
    ],
    dependencies: [
    ],
    targets: [
        .target(
            name: "SomeDependencyAPI",
            dependencies: []),
        .target(
            name: "SomeDependencyAPITestData",
            dependencies: ["SomeDependencyAPI"]),
        .testTarget(
            name: "SomeDependencyAPITests",
            dependencies: ["SomeDependencyAPITestData", "SomeDependencyAPI"]),
    ]
)

brentleyjones

Because these are statically linked, we should treat them like target dependencies that are static libraries. What this means is that if I declare the following:

packages:
  Yams:
    url: https://github.com/jpsim/Yams
    majorVersion: 2.0.0
targets:
  App:
    dependencies:
      - target: StaticLibraryA
      - package: Yams
  StaticLibraryA:
    dependencies:
      - package: Yams

Then Yams should only be linked to App, not StaticLibraryA, otherwise we will get duplicated symbols. (And the same if only StaticLibraryA declared the dependency). You can see how it was done at https://github.com/yonaskolb/XcodeGen/blob/swift_packages/Sources/XcodeGenKit/PBXProjGenerator.swift#L470-L479 for target dependencies.

We also need to add the packages as Target Dependencies (especially once you make the above change, since Xcode won't know to build the SPM package before building StaticLibraryA):

Really nice work @yonaskolb!

brentleyjones · 2019-08-13T17:16:11Z

For example, without the above change we get the following on one of our static library targets:

kdubb · 2019-08-17T01:48:46Z

This works great for us! Thanks!

Supporting local packages would help us immensely when it comes to project maintenance. This seems like it should be fairly easy since Xcode 11 already fully supports local packages.

A little background for use case...

Our main usage of this feature is to generate xcode projects for our Swift Package Manager projects that need to be tested on multiple platforms via command line; especially those with special requirements.

For example, our security framework requires the keychain access entitlement on all platforms except macOS to run unit tests. To facilitate CI we generate a project using xcodegen that has host applications setup for each of the test targets and those host applications are granted keychain access. We then simply use xcodebuild to build and run tests for each platform.

Now that xcodegen supports package dependencies we can generate a fairly straightforward project for the framework, then we add our test & test host targets. Unfortunately this means we are duplicating package dependencies that are already defined in our Package.swift. While this is way better than previous, it requires us to keep dependency versions up to date in 2 places, Package.swift and project.yml.

Supporting local packages would allow us to generate an xcodeproj that contains only test targets & test host targets. They would reference a package dependency to the local folder (e.g. .) which defines the framework itself as a package. This would be solve maintaining dependencies in two places as well as test the framework as as Swift package which is how it will be consumed.

mbuchetics · 2019-09-19T08:55:54Z

With Xcode 11 Final right around the corner ... are there any plans on merging this soon into master with an official release?

test

yonaskolb · 2019-09-27T09:27:27Z

Ok I've:

rebased
added some more docs
prevented linking to static libs
added a commented out stub for adding package target dependencies. It requires this PR I created in XcodeProj first Add PBXTargetDependency.productReference tuist/XcodeProj#481. Interestingly Xcode doesn't do this if you add a dependency via it's UI, so I wouldn't say that should stop this PR from being merged and released.

@brentleyjones could you look this over again, and make sure it works with your static library setup

@mmmilo

Is it possible to allow for adding multiple products?

To accomplish that you can use multiple dependency declarations. This allows us to control settings for a single linkage if needed

dependencies:
  - package: SomeDependency
    product: SomeDependency # this isn't required
  - package: SomeDependency
    product: SomeDependencyTestData

@kdubb

Supporting local packages would help us immensely when it comes to project maintenance. This seems like it should be fairly easy since Xcode 11 already fully supports local packages.

Yes this will be possible. It isn't in this PR but will come in a followup one. It's just adding a path as a PBXFileReference and Xcode takes care of the rest.

@mbuchetics

With Xcode 11 Final right around the corner ... are there any plans on merging this soon into master with an official release?

Yes, I'd like to get this released as soon as possible. If you could test it on your setup that would help.

Mint makes this easy:

mint run yonaskolb/xcodegen@swift_packages xcodegen generate

yonaskolb · 2019-09-27T11:37:46Z

I've added support for package target dependencies for proper build dependency resolution.
I've also added local swift package support. For the moment it doesn't support linking these unless they mirror remote packages

mbuchetics · 2019-09-27T12:35:15Z

I just experimented with it (see https://github.com/allaboutapps/ios-starter/tree/spm) and it works great!
However, I ran into https://bugs.swift.org/browse/SR-10927 again ... this is a huge issue for us and we won't be able to use SPM until this is fixed. Can't believe this made it into 11.1 :(

…sGroup

brentleyjones · 2019-09-27T13:38:04Z

@yonaskolb I'll start reviewing this shortly. I'll let you know!

brentleyjones

Works great!

yonaskolb · 2019-09-28T06:23:16Z

Released in 2.8.0!

PR yonaskolb#624 introduced a bug with operator priorities discarding false link settings for dependencies when the target is an executable and the dependency a static library. This PR fixes that.

PR #624 introduced a bug with operator priorities discarding false link settings for dependencies when the target is an executable and the dependency a static library. This PR fixes that.

yonaskolb force-pushed the swift_packages branch from b478357 to e3b66f8 Compare August 13, 2019 12:08

This was referenced Aug 13, 2019

SPM packages and Test Plans #606

Closed

Support Swift Packages #617

Closed

yonaskolb requested review from ryohey, brentleyjones and toshi0383 August 13, 2019 12:18

toshi0383 approved these changes Aug 13, 2019

View reviewed changes

brentleyjones reviewed Aug 13, 2019

View reviewed changes

brentleyjones requested changes Aug 13, 2019

View reviewed changes

yonaskolb added 7 commits September 27, 2019 17:10

add packages to project spec

fa5bd83

add project tests

f555071

test

generate packages

e3fc07d

add spm fixture

4939cbf

docs

8050e6b

add package validation

fe693c7

more docs

fbcf9ab

yonaskolb mentioned this pull request Sep 27, 2019

Add PBXTargetDependency.productReference tuist/XcodeProj#481

Merged

yonaskolb added 2 commits September 27, 2019 19:00

add stub of swift package target dependency

98ed446

don't link packages to static libraries

6c9b814

yonaskolb force-pushed the swift_packages branch from e4acc8d to 6c9b814 Compare September 27, 2019 09:12

yonaskolb closed this in tuist/XcodeProj#481 Sep 27, 2019

added package target dependency with XcodeProj 7.1.0

4145359

yonaskolb reopened this Sep 27, 2019

add support for localPackages

e9193cf

yonaskolb added 2 commits September 27, 2019 21:43

make local packages relative

8e6195c

update changelog

6da4686

yonaskolb force-pushed the swift_packages branch from bea4f4a to 6da4686 Compare September 27, 2019 11:52

add a swift generation test

0300e7f

yonaskolb added 2 commits September 27, 2019 22:49

put local packages into a Packages group and add options.localPackage…

8e48c7b

…sGroup

add version and from

06eed64

yonaskolb mentioned this pull request Sep 27, 2019

Generate from Swift PM Package #196

Closed

brentleyjones approved these changes Sep 27, 2019

View reviewed changes

yonaskolb merged commit c780ed3 into master Sep 27, 2019

yonaskolb deleted the swift_packages branch September 27, 2019 14:31

rcari mentioned this pull request Oct 31, 2019

Fixing link directive on dependencies #703

Merged

uhooi mentioned this pull request Nov 20, 2020

Replace CocoaPods to SwiftPM uhooi/UhooiPicBook#86

Closed

erichoracek mentioned this pull request Jan 13, 2023

Set up new SPM package and configure CI airbnb/lottie-spm#1

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for Swift Packages #624

Support for Swift Packages #624

yonaskolb commented Aug 13, 2019 •

edited

Loading

toshi0383 left a comment

brentleyjones left a comment

brentleyjones Aug 13, 2019

yonaskolb Sep 27, 2019

mmmilo commented Aug 13, 2019 •

edited

Loading

brentleyjones left a comment •

edited

Loading

brentleyjones commented Aug 13, 2019

kdubb commented Aug 17, 2019

mbuchetics commented Sep 19, 2019

yonaskolb commented Sep 27, 2019

yonaskolb commented Sep 27, 2019

mbuchetics commented Sep 27, 2019

brentleyjones commented Sep 27, 2019

brentleyjones left a comment

yonaskolb commented Sep 28, 2019

Support for Swift Packages #624

Support for Swift Packages #624

Conversation

yonaskolb commented Aug 13, 2019 • edited Loading

toshi0383 left a comment

Choose a reason for hiding this comment

brentleyjones left a comment

Choose a reason for hiding this comment

brentleyjones Aug 13, 2019

Choose a reason for hiding this comment

yonaskolb Sep 27, 2019

Choose a reason for hiding this comment

mmmilo commented Aug 13, 2019 • edited Loading

brentleyjones left a comment • edited Loading

Choose a reason for hiding this comment

brentleyjones commented Aug 13, 2019

kdubb commented Aug 17, 2019

mbuchetics commented Sep 19, 2019

yonaskolb commented Sep 27, 2019

yonaskolb commented Sep 27, 2019

mbuchetics commented Sep 27, 2019

brentleyjones commented Sep 27, 2019

brentleyjones left a comment

Choose a reason for hiding this comment

yonaskolb commented Sep 28, 2019

yonaskolb commented Aug 13, 2019 •

edited

Loading

mmmilo commented Aug 13, 2019 •

edited

Loading

brentleyjones left a comment •

edited

Loading