Moya: Our release numbers are incompatible with the swift package manager

[AndrewSB]

Quick heads up: the alpha & beta releases we're publishing aren't compatible with spm v3.

I'm going to figure out the correct format, post it here, and potentially re-release our 9.0 alpha with that format

[AndrewSB]

Looks like the .1 at the end breaks the format.
This section in their documentation talks about how to format version numbers: https://github.com/apple/swift-package-manager/blob/master/Documentation/PackageDescriptionV3.md#version
It's of the sort "major.minor.patch[-prereleaseIdentifiers][+buildMetadata]".

So we should publish
🎉 9.0.0-alpha1 or
❤️ 9.0.0-alpha+1

What do @Moya/contributors think (vote with a reaction to this comment 😉)?

[sunshinejr]

Thanks for the finding, @AndrewSB. This is strange, though. From what I've known, 9.0.0-alpha.1 seems like a valid semver release number. Also, from the docs:

NOTE: prereleaseIdentifiers are separated by dot (.).

Doesn't it mean that alpha.1 should be valid? 🤔

[pedrovereza]

As @sunshinejr mentioned 9.0.0-alpha.1 is indeed a valid semver number. A bit weird that SPM can't handle it 🤔

[BasThomas]

Let's create an issue over at SPM and go with 🎉 for now?

[freak4pc]

Agree that 9.0.0-alpha1 makes sense in general, and if it solves this - even better. Wondering on why alpha.1 doesn't budge, seems like it should... based on SEMVER. Seems like a pretty definite SPM bug.

[BasThomas]

@AndrewSB what environment did you run this in? So I can add it to the Swift bug :)

[BasThomas]

https://bugs.swift.org/browse/SR-5693

[AndrewSB]

Yeah, this was really strange. I thought our 9.0.0-alpha.1 release was compatible with semver

here's my swift info @BasThomas:

👋 swift -v                                                                   ~
Apple Swift version 3.1 (swiftlang-802.0.53 clang-802.0.42)
Target: x86_64-apple-macosx10.9
/Library/Developer/CommandLineTools/usr/bin/lldb "--repl=-enable-objc-interop -sdk /Library/Developer/CommandLineTools/SDKs/MacOSX.sdk -color-diagnostics"
Welcome to Apple Swift version 3.1 (swiftlang-802.0.53 clang-802.0.42). Type :help for assistance.

lldb stuff might be unrelated, I'm currently working on a project related to lldb

[sunshinejr]

Oh, I think I found it (see this SO answer). Seems like a git issue? Quickfix should be to delete/rename 9.0.0-alpha.1 branch. What do you guys think?

[freak4pc]

You can make a tag and nuke the branch to test this I think ? If you're wrapping up this release anyways it's worth a shot IMO @sunshinejr

[AndrewSB]

really nice catch @sunshinejr 😄 let's do it

[sunshinejr]

Branch deleted @AndrewSB, can you check if it works? 😄

[AndrewSB]

It doesn't work, but it looks like a different error

no complaints about the refname

this should be easily repro-able. My Package.swift is just

import PackageDescription

let package = Package(
    name: "<NAME>",
    dependencies: [
        .Package(url: "https://github.com/Moya/Moya.git", majorVersion: 9),
    ],
    exclude: [
        "thrift",
    ]
)

EDIT

I just made sure spm works without complaint on majorVersion 8, it did. Here's the output:

[sunshinejr]

@AndrewSB I think that prerelease won't get in the major/minor range (at least that was a thing when I used SPM last). You probably need to specify a version to get it working.

[freak4pc]

Yeah you're right @sunshinejr : https://github.com/apple/swift-package-manager/blob/master/Sources/PackageDescription/Version.swift#L23

I'll confirm on my end as well a bit later if @AndrewSB isn't back by then

[freak4pc]

@sunshinejr @AndrewSB This seems to work just fine for installation but getting a different error, not sure if it's related to my dummy project or Moya:

import PackageDescription

let package = Package(
    name: "Moya",
    dependencies: [
        .Package(url: "https://github.com/Moya/Moya.git", Version(9, 0, 0, prereleaseIdentifiers: ["alpha", "1"])),
    ]
)

[SD10]

@freak4pc The output from @AndrewSB is showing the same warning. I'm not sure if we had this warning in previous versions but it looks like it's from the Supporting Files group not having any .swift files. @sunshinejr Did we recently refactor this group?

[freak4pc]

@SD10 It was an Edit so didn't see it ;) And also that was with Major 8, and we wanted to confirm there's no problem with the 9.0.0-alpha.1 versioning

I think the problem is it treats every folder as a Module even though in this case this is shared code. Perhaps that folder could be excluded ? I guess it would break the build as well though 🤔

[sunshinejr]

@freak4pc @SD10 I think this is just a warning and we have this for quite some time now. The module should build, though. However, we can take care of it so I've created #1224 😉

[freak4pc]

So regarding this specific ticket there is no issue with SPM-specific versioning so we can just close here IMO? @sunshinejr

[sunshinejr]

I believe so! If there is a way of improving/fixing the error on SPM, that's on their side now I think. We can always reopen in case something happens. Thanks everyone for helping out! 👏

[BasThomas]

Should I update the SPM bug?

[sunshinejr]

It would be awesome. TL;DR we found the issue (having tag and branch with the same name, removing branch helped). If there is something SPM could do to fix the issue or improve error handling, it would be great 😉