Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Would you consider dual-tagging GRDB releases until SPM supports your preferred tag format? #1125

Closed
jackpal opened this issue Jan 5, 2022 · 17 comments
Closed

Would you consider dual-tagging GRDB releases until SPM supports your preferred tag format? #1125

jackpal opened this issue Jan 5, 2022 · 17 comments
Labels
wontfix Impossible to fix, or bad idea

Comments

@jackpal
Copy link

jackpal commented Jan 5, 2022

As I understand it, Swift Package Manager requires tags to be in the format 1.0.0 (without any prefix), while GRDB strongly prefers the format v1.0.0.

I understand that you've filed a bug requesting that SPM be extended to support the GRDB project's preferred tag format.

But in the meantime, would you be willing to double-tag your releases, so that each release has both a v tag and a SPM-compatible tag?

As things currently stand, it's hard for people to write Swift Package Manager packages that depend on GRDB.
@groue
Copy link
Owner

groue commented Jan 5, 2022 •
edited
Loading

Hello @jackpal,

As things currently stand, it's hard for people to write Swift Package Manager packages that depend on GRDB.

I assume this issue is related to #1115. If it is not, please better describe your concern.

Swift Package Manager requires tags to be in the format 1.0.0 (without any prefix)

This is not true. You can build an app or a package that depends on the GRDB package today. SPM is one of the supported, documented, and tested installation methods of GRDB, since version 0.106.0 in April 2017.

But in the meantime, would you be willing to double-tag your releases, so that each release has both a v tag and a SPM-compatible tag?

I know that SPM does not support dually tagged packages. I once mistakenly published a 3.0.0 tag without prefix, and this completely broke SPM support (#368). Admittedly, maybe this is different now.

I understand that you've filed a bug requesting that SPM be extended to support the GRDB project's preferred tag format.

This format is not a whim. v-prefixed tags are a widely used convention, which predates SPM by several years. It is explicitly mentioned in https://semver.org:

Is “v1.2.3” a semantic version?

No, “v1.2.3” is not a semantic version. However, prefixing a semantic version with a “v” is a common way (in English) to indicate it is a version number. Abbreviating “version” as “v” is often seen with version control. Example: git tag v1.2.3 -m "Release version 1.2.3", in which case “v1.2.3” is a tag name and the semantic version is “1.2.3”.

Finally, even when Apple eventually fixes this bug in the Swift Playgrounds on iPad application, this won't allow you to use GRDB there until system modules are supported (https://twitter.com/damienpetrilli/status/1472144736983134211).

All in all, I don't see any reason to do anything in the GRDB repo at the present time.

Let's wait for the Apple/SPM teams to fix their bugs and build the features requested by the community. You may want to let them know you'd like to use GRDB at https://feedbackassistant.apple.com

@jackpal
Copy link
Author

jackpal commented Jan 5, 2022

Thanks for explaining! Seems like a tough situation.

My request is motivated by trying to create a Swift library package that depends upon GRDB. I guess #1115 is very similar. It's about an executable package, but the root cause is probably the same.

By the way, could you explain why GRDB is using "system" for it's C target? Shouldn't it be possible to have a C target without using "system"? Is "system" required to work around some other issue?

@JayToltTech
Copy link

JayToltTech commented Jan 5, 2022 •
edited
Loading

FYI, failed to create a SPM library which has a dependency on GRDB due to this semver issue with XCode Version 13.2.1 (13C100)

Screen Shot 2022-01-05 at 8 12 58 AM

import PackageDescription

let package = Package(
    name: "...",
    products: [
        .library(
            name: "...",
            targets: ["...","..."]),
    ],
    dependencies: [
        .package(url: "https://github.com/stephencelis/SQLite.swift.git", from: "0.13.1"),
        .package(url: "https://github.com/groue/GRDB.swift.git", from: "v5.17.0")
    ],
    targets: [
        .target(
            name: "...",
            dependencies: [
                .product(name: "SQLite", package: "SQLite.swift"),
                .product(name: "GRDB", package: "GRDB.swift")
            ])
    ]
)

@JayToltTech
Copy link

As a temporary workaround for anyone else who is caught in this thread, I forked/updated the tag so you don't have to:

.package(url: "https://github.com/JayToltTech/GRDB.swift.git", from: "5.17.0")

Note: temporary fork, not going to be updated, expect this to disappear once this issue is resolved one way or the other.

@jackpal
Copy link
Author

jackpal commented Jan 5, 2022 via email

@jackpal
Copy link
Author

jackpal commented Jan 5, 2022 •
edited
Loading

@JayToltTech - thanks for chiming in. I was wondering if doing a fork and tag rename would work.

I guess GRDB doesn't want to switch to SPM compatible tags because it would break every existing downstream dependency that is depending on the old tags. (Presumably these are not SPM dependencies.)

GRDB could fork a GRDB-legacy-tags.git, then the update the mainline GRDB to use SPM-compatible tags. Every client that depended on the legacy tag format would have to manually change their dependencies by changing which git repo they pulled from.

I see why GRDB is choosing to live with broken SPM support, in the hope that SPM is updated to support GRDB someday. But is sure is frustrating as someone trying to use GRDB as a dependency.

@JayToltTech
Copy link

Also, I didn't remove tag v5.17.0, I just added tag 5.17.0 pointing to the same commit and all worked fine with SPM, so #368 doesn't seem to be an issue at this point.

@groue
Copy link
Owner

groue commented Jan 5, 2022 •
edited
Loading

FYI, failed to create a SPM library which has a dependency on GRDB due to this semver issue with XCode Version 13.2.1 (13C100)

The issue, @JayToltTech, is in your package file: "v5.17.0" is not a semantic version. You can fix your package as below:

import PackageDescription

let package = Package(
    ...
    dependencies: [
        .package(name: "GRDB", url: "https://github.com/groue/GRDB.swift.git", .upToNextMajor(from: "5.17.0")),
    ],
    targets: [
        .executableTarget(
            name: "...",
            dependencies: ["GRDB"]),
    ]
)

I deeply regret SPM is so immature, and that I have to answer this kind of issue. I'm not paid by Apple to provide support for their lacking environment. But please don't mismatch SPM issues, poor ergonomics, and bad error reporting with issues in community packages.

Here the problem(s) are clearly on the SPM side. If you have concerns, do raise your voice at the correct location, thank you.

@groue groue closed this as completed Jan 5, 2022
@groue
Copy link
Owner

groue commented Jan 5, 2022 •
edited
Loading

I guess GRDB doesn't want to switch to SPM compatible tags because it would break every existing downstream dependency that is depending on the old tags. (Presumably these are not SPM dependencies.)

Yes. This is basic respect for the work of GRDB users.

I see why GRDB is choosing to live with broken SPM support, in the hope that SPM is updated to support GRDB someday. But is sure is frustrating as someone trying to use GRDB as a dependency.

I fully agree. Frustrated users, I beg you to report Apple bugs to Apple. I can't do it for you.

I understand it is easier to calm one's frustration on an open source volunteer. But in such situations, this does strictly nothing to help fixing your problem. Use https://feedbackassistant.apple.com. Ideally, report any progress on this side so that all GRDB users are aware of the progress.

@jackpal jackpal mentioned this issue Jan 5, 2022
Closed
@JayToltTech
Copy link

@groue reported to Apple as you requested.

From a pure practicality standpoint, assuming the responsible apple developer takes your viewpoint that "v*" is acceptable, it will be many months before XCode and the toolchain is released with a fix. And as an impartial third party, I'm not certain your argument will be received as 'unquestionably correct'. Is there a value in perhaps thinking that a Swift library should adapt itself to work with the Swift toolchain that Apple provides, as opposed to the other way around?

One of the reasons for the fork is that you can use that repo to test for other unintended consequences or breakages with the dual tag approach, if you were so inclined.

@groue
Copy link
Owner

groue commented Jan 5, 2022 •
edited
Loading

You are not impartial, @JayToltTech, you are lost.

There is no problem with GRDB support for SPM with Xcode, as far as I know. This is not a GRDB issue, it is a buggy package definition that has to be fixed.

There is a problem with Swift Playgrounds for iPad. This app is buggy. I won't create difficulties for other GRDB users who are working hard in order to satisfy the desire of a few people to fiddle with an immature application.

@JayToltTech
Copy link

Ouch!

Hey, thanks for all the great work here @groue, it's much appreciated.

I know open source development can feel like it's a lot of conflict and not a lot of gratitude. Wasn't trying to be that person to you.

  • Jay

@groue
Copy link
Owner

groue commented Jan 5, 2022

Don't worry! I had to put an end to what looked like an endless argument 😅 For whoever read this discussion in the future, make sure you read the reasons why this request was rejected, all listed in the previous comments.

@groue groue added the wontfix Impossible to fix, or bad idea label Jan 5, 2022
@JayToltTech
Copy link

JayToltTech commented Jan 24, 2022 •
edited
Loading

FYI, in case you're waiting for Apple to change their mind @groue:

Jan 5, 2022 at 10:19 AM – FB9833870
SemVer issues with package dependencies in SPM

Recent Similar Reports:None
Resolution:Investigation complete - Works as currently designed

Apple, Jan 12, 2022 at 1:47 PM
Yes, that string is invalid and it seems like the GitHub thread ended with the same conclusion.

@groue
Copy link
Owner

groue commented Jan 25, 2022 •
edited
Loading

Let me repeat the arguments I gave above, @JayToltTech, because they still stand:

Until each one of those arguments is addressed, I do not see any reason to change my decision, which is to keep the current tagging policy.

Yet your energy is quite welcome! What about spending it on writing an answer to the Apple engineer, with all the reasons why Swift Playgrounds for iPad should support "v..." tags? This would be a helpful contribution.

@groue
Copy link
Owner

groue commented Jan 25, 2022

Just in case it can help, I reported the issue in the Swift forums as well.

@groue
Copy link
Owner

groue commented Jan 25, 2022

It did help indeed.

This definitely closes this issue. There is no debate: the bug is in Swift Playgrounds for iPad, and the tagging scheme of GRDB is totally legit.

Thanks to everyone!

@groue groue mentioned this issue Aug 22, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
wontfix Impossible to fix, or bad idea
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@groue @jackpal @JayToltTech