Repo not structured properly for Swift Package

Question

Repo not structured properly for Swift Package

PatrickDanino opened this issue 3 years ago · 16 comments

Xcode is generating dozens of warnings about the Branch SDK when included via the SPM. These warnings cannot be turned off by default and are generating noise that hides other legitimate warnings.

Example of a warning when archiving:
Warning: Umbrella header for module 'Branch' does not include header 'BNCTuneUtility.h'`

SPM requires that the headers be split between two folders, one for public headers and the other for private headers. You can then specify the private folder as a headerSearchPath and add it to the exclude list in Package.swift. By default, public headers put in an include folder will be automatically picked up.

TaimoorSaeed commented 2 years ago

+1

Answer 1 · 2021-10-19T23:05:41.000Z

@PatrickDanino I see they have a separate repo for SPM. Perhaps that one has fewer warnings (haven't tried it yet). https://github.com/BranchMetrics/ios-branch-sdk-spm

Answer 2 · 2021-10-26T21:06:06.000Z

Per the description, that repo is a mirror of this one (with some history removed). As such, both have the same issues described above.

Answer 3 · 2021-12-16T09:06:20.000Z

We experienced the same issue and now we can't use Branch SDK with SPM

Answer 4 · 2021-12-29T11:57:37.000Z

We have the same problem. Those warnings become errors when GCC_TREAT_WARNINGS_AS_ERRORS is enabled. We had to disable it, at least now.
We are using the SPM specific repo (https://github.com/BranchMetrics/ios-branch-sdk-spm) with version 1.40.2

Answer 5 · 2022-02-15T22:18:28.000Z

We have this earmarked for end of quarter.

Answer 6 · 2022-06-02T21:54:52.000Z

Hi @echo-branch is there an update on this issue?

Answer 7 · 2022-06-02T22:04:27.000Z

So it was in progress, but got shelved for other work. I'm picking it back up this next sprint.

Answer 8 · 2022-07-18T06:00:07.000Z

@echo-branch Hi, any updates?

Answer 9 · 2022-07-18T18:25:56.000Z

It slipped yet again. This time due to dev illness and vacations. It is still the top item though.

Answer 10 · 2022-08-18T11:08:56.000Z

@echo-branch Hi, any chance for updates?
Thanks

Answer 11 · 2022-08-19T16:35:20.000Z

In progress. The layout refactor has cascading impact on our build, testing and documentation. So it's taking some time to get everything lined up.

Answer 12 · 2022-08-20T13:15:47.000Z

In progress. The layout refactor has cascading impact on our build, testing and documentation. So it's taking some time to get everything lined up.

Thanks for the update

Answer 13 · 2022-09-21T19:05:05.000Z

@echo-branch any update here? This was fine for Xcode 13.4 but we';re getting tons of warnings in Xcode 14

Answer 14 · 2022-09-21T19:24:57.000Z

@jhurray
I suspect you had the type of warning ignored before, cause it's been an issue for almost a year now.

We're still chipping away at the problem internally, the fix will required renaming our SDK which means updating a lot of docs, build and testing. We also have dependencies such as RN, Unity etc to manage along with this. Our initial 1 or 2 sprint estimate was way off. I don't have a firm date, but it'll be a major release.

Answer 15 · 2023-04-19T20:08:07.000Z

This was shipped with 2.0.0