Error parsing the Package.swift file

[daveverwer]

Description

Hello! I'm part of the Swift Package Index team and was just trying to add this package to the index. We use swift package dump-package to extract package metadata in as JSON but when running that command for this package, the following error occurs:

$ xcrun swift package dump-package
/Users/dave/Desktop/aws-sdk-swift: error: manifest parse error(s):
main/Package.swift:104: Fatal error: 'try!' expression unexpectedly raised an error: Error Domain=NSCocoaErrorDomain Code=260 "The folder “release” doesn’t exist." UserInfo={NSFilePath=/Users/dave/Projects/Amplify/SwiftSDK/aws-sdk-swift/release, NSUserStringVariant=(
    Folder
), NSUnderlyingError=0x600000a28090 {Error Domain=NSOSStatusErrorDomain Code=-43 "fnfErr: File not found"}}
error: invalid manifests at [<AbsolutePath:"/Users/dave/Desktop/aws-sdk-swift">]

This is broken on main but works on the 0.1.0 tag. Unfortunately, to add the package to the index we need to be able to initially run the dump-package on a checkout of the default branch.

Environment

• AWS Swift SDK version used: This is broken on main but works on the 0.1.0 tag.
• Operating System and version (iOS/macOS/Linux): macOS Monterey
• Xcode version (if applicable): Version 13.1 (13A1030d)
• Swift compiler version (if applicable): Apple Swift version 5.5.1 (swiftlang-1300.0.31.4 clang-1300.0.29.6)
• Swift Tools version (if applicable): Apple Swift version 5.5.1 (swiftlang-1300.0.31.4 clang-1300.0.29.6)

Reproduction Steps

• Check out the main branch of this repository locally.
• Change into the checked out directory.
• Run xcrun swift package dump-package

Observed Behavior

The manifest fails to parse.

Expected Behavior

The manifest parses successfully.

---

Thank you!

[wooj2]

Hi @daveverwer,
By design, main branch is used for code generation source code. The reason why the main branch has a Package.swift file is to facilitate local development of the SDKs (e.g, As a code generation developer, I can generate AWS SDKs on my dev machine, and execute them against local versions of the AWSClientRuntime, ClientRuntime and CRT), rather than public consumption. There are currently no plans to support adding generated SDKs in the main branch. Are there any work-arounds on your side to avoid pointing to main?

[daveverwer]

Are there any work-arounds on your side to avoid pointing to main?

I've just done some investigation this afternoon on how our system would deal with a package with a broken manifest on the default branch and it's mixed news:

Compared to this for your other package:

One misleading bit from these screenshots is that we'd also be able to show a compatibility matrix for the package. That's missing here as I don't have the build system set up locally. However, that matrix would show that the main branch was broken across all Swift versions and platforms as those all fail to build due to the broken manifest. It would show the correct compatibility information for the tagged releases, though.

The good news is that some of the bits of information we can't get because of the broken manifest are just being omitted (dependency information, library/executable counts, etc...) and nothing is fundamentally broken. Others, like getting the version information and the fact that we never successfully "finish" processing the package are harder to fix. This means it would currently never appear in package search results.

It would be possible for us to start to work around some of these issues, but I'm not sure there are many occurrences of a package with an intentionally broken manifest, so it might not be a top priority.

I think the best solution, for now, is for it to stay out of the index. I'll leave it for you to decide whether to close this issue or not!

[ganeshnj]

Related #620

[jbelkins]

@daveverwer Our default branch (main) should now build out-of-the-box without further config, so we're hoping that this package may now be successfully indexed.

We've submitted your form: SwiftPackageIndex/PackageList#3058

We'll read the FAQ for Swift Package Index & do what's necessary to keep us listed & up-to-date. Meanwhile, please let us know if there are any further issues with the intake of this package. Thanks!