Add Swift Package Manager support #131

Kyle-Ye · 2022-04-05T17:19:37Z

Add Swift Package support
Update file structure to standard swift package
Fix SPM warning

https://www.swift.org/package-manager/

After the change, we can just use swift build to get the executable, swift run to run it and swift test to run tests.

And other swift package or swift package plugin can depend on this.

This PR does not remove Xcode project support and change the release workflow.

Kyle-Ye · 2022-04-05T17:21:48Z

Tests/DockUtilTests/Tests.swift

@@ -22,8 +22,8 @@ class Tests: XCTestCase {
    func testDock() throws {
        // This is an example of a functional test case.
        // Use XCTAssert and related functions to verify your tests produce the correct results.
-        let dock = Dock()
-        XCTAssert(dock.items.count > 0)
+//        let dock = Dock()


Due to the API change, this will not compile. Temporally comment them.

Kyle-Ye · 2022-05-18T13:25:57Z

@kcrawford Could you help review this in your spare time? Some downstream needs SPM support. ❤️

…at least until [dockutil updates to Swift package management][2] and [Homebrew updates to dockutil v3][3]. [1]: kcrawford/dockutil#127 (comment) [2]: kcrawford/dockutil#131 [3]: Homebrew/homebrew-core#97394

mathbunnyru · 2022-07-30T18:26:44Z

@kcrawford many people would like to use this beautiful utility you created, but they can't without easy installation way (i.e. Homebrew).
Please, take a look at this PR, it will help so many users of your dockutil

…at least until [dockutil updates to Swift package management][2] and [Homebrew updates to dockutil v3][3]. [1]: kcrawford/dockutil#127 (comment) [2]: kcrawford/dockutil#131 [3]: Homebrew/homebrew-core#97394

ashtonian · 2022-10-31T18:07:17Z

@kcrawford any chance you could take a look?

sroberts · 2023-01-14T19:49:26Z

I'd like to bump this? The version of Dockutil in Homebrew is out of date and unusable, and this is blocking Homebrew/homebrew-core#97394 to get this updated.

TheNite · 2023-02-27T21:13:04Z

dam did this project die?

Austin1 · 2023-03-19T21:09:48Z

Could a community member maybe get access to merge some of these pull requests? I would do it if I was a developer, but you don't want me with those keys. @kcrawford

@Kyle-Ye would you be interested if @kcrawford responds?

sroberts · 2023-03-20T01:37:56Z

It may just be time to fork this project and move on, doesn't look like @kcrawford has been active in over a year.

Kyle-Ye · 2023-03-20T03:30:52Z

Could a community member maybe get access to merge some of these pull requests? I would do it if I was a developer, but you don't want me with those keys. @kcrawford

@Kyle-Ye would you be interested if @kcrawford responds?

Yes, I'm fine to keep the project moving on.

kcrawford · 2023-03-20T05:45:32Z

I’m sorry for the delays. I don’t want to merge something I don’t understand as I have to maintain this going forward. I haven’t yet made time to understand this and why alternatives weren’t chosen to solve homebrew compatibility. I’ll try to look into it as soon as I have some time. If anyone can point me to more info on why this is the best/standard way to handle open source swift projects and homebrew I’d appreciate it. Can you also briefly explain why a pkg doesn’t work for your use case. I’m not trying to be difficult—I genuinely don’t understand and that’s probably a reason this has been neglected.

Kyle-Ye · 2023-03-20T06:16:47Z

I’m sorry for the delays. I don’t want to merge something I don’t understand as I have to maintain this going forward. I haven’t yet made time to understand this and why alternatives weren’t chosen to solve homebrew compatibility. I’ll try to look into it as soon as I have some time. If anyone can point me to more info on why this is the best/standard way to handle open source swift projects and homebrew I’d appreciate it. Can you also briefly explain why a pkg doesn’t work for your use case. I’m not trying to be difficult—I genuinely don’t understand and that’s probably a reason this has been neglected.

@kcrawford If you have your time available, you can spend some time checking the following posts.

https://github.com/orgs/Homebrew/discussions/59

Homebrew/homebrew-core#97394

kcrawford · 2023-03-27T00:42:49Z

Thanks @Kyle-Ye. I was able to build from your branch using swift build, but building from Xcode failed for me (Info.plist not found, 'XCTestSwiftSupport', 'XCTest' not found) and top level directories and files like Sources and Package.swift are not visible in Xcode. I don't like the duplicated hard-coded VERSION though I see the reason. Do you think we can make this look and act like a fresh new Swift Package from Xcode Template so Xcode handles it as expected. Maybe starting with that and adding in the classes would be cleaner.

Kyle-Ye · 2023-03-27T02:38:14Z

Got it, I'll update the commits and make it ready for review once it's done. @kcrawford

But I have 2 questions:

Should we still preserve .xcodeprojc support / provide support for both Xcode project and Swift Package? IMO, the answer is NO.
Should we still use info.plist to store the version information? Swift Package Manager currently does not have a very support support for custom Info.plist.

A workaround is discussed here https://forums.swift.org/t/swift-package-manager-use-of-info-plist-use-for-apps/6532/13

kcrawford · 2023-03-27T05:50:32Z

Should we still preserve .xcodeprojc support / provide support for both Xcode project and Swift Package? IMO, the answer is NO.

Being new to Swift Package development I don't know the implications of this. I'd want full Xcode support.

Should we still use info.plist to store the version information? Swift Package Manager currently does not have a very support support for custom Info.plist.

Again I don't know, but I'd want minimal workarounds. Having info.plist support seems important.

It may make sense for me to attempt the conversion to Swift Package just so I feel comfortable with the changes.

Kyle-Ye · 2023-04-03T13:30:48Z

Thanks @Kyle-Ye. I was able to build from your branch using swift build, but building from Xcode failed for me (Info.plist not found, 'XCTestSwiftSupport', 'XCTest' not found) and top level directories and files like Sources and Package.swift are not visible in Xcode. I don't like the duplicated hard-coded VERSION though I see the reason. Do you think we can make this look and act like a fresh new Swift Package from Xcode Template so Xcode handles it as expected. Maybe starting with that and adding in the classes would be cleaner.

Fixed the Info.plist not found and XCTest import issue on xcodeproj.
The version info in Info.plist is $(CURRENT_PROJECT_VERSION) which is defined on .xcodeproj file. So even we force inserting Info.plist to SPM system. We still can't get the info on .xcodeproj file. IMO, there is really no reason to preserve .xcodeprojc support. Once we drop xcodeproj support. There will be no duplicated hard-coded VERSION issue left.

rgl · 2023-06-24T09:51:17Z

@kcrawford, can you please review/merge this PR?

Is there a CI pipeline for this project somewhere? If there isn't, I can try to create one using GitHub Actions and/or Cirrus CI.

PS: GitHub Actions Workflow PR is now at #152.

ChrisCarini · 2023-06-29T15:45:38Z

@kcrawford - any updates here?

booch · 2023-09-26T03:28:21Z

Homebrew just recently marked dockutil as deprecated. That's going to significantly reduce the number of people able to use dockutil. That's a shame, because it's a great little utility. I use it in my Mac setup scripts. Merging this is probably the only hope to fix that.

straxhaber · 2023-10-01T23:34:21Z

@kcrawford is there any chance you could find time to review this patch? Lots of folks want to use dockutil through Homebrew, and this is blocking them from doing so. As @booch said, this is a neat tool and it would be great if more folks could benefit from your work. I'm sure there are volunteers in this thread or in the Homebrew thread that would be happy to help you with anything you need to accomplish this if you respond.

Kyle-Ye · 2023-10-02T04:48:42Z

I have created a fork and release 3.0.3 to add SwiftPM build support.

Are there any HomeBrew volunteer who would like to help reopen a HomeBrew PR against my fork? - https://github.com/Kyle-Ye/dockutil/releases/tag/3.0.3.

Homebrew/homebrew-core#97394 cc @sashkab

kcrawford · 2023-10-11T17:26:58Z

It is still my intention to implement this. Just want to become familiar with it and haven’t had time. Hopefully will get to it soon. I feel terrible that it is taking so long.

straxhaber · 2023-10-17T15:27:09Z

Hi @kcrawford, I just want to make sure you're aware that the HomeBrew project has now marked your project as "deprecated." I just noticed this. I'm not involved with Homebrew, but I really hope you can fix this before they remove Dockutil entirely. I bet a lot of your users find and install this via Homebrew. Is there any chance you could either make this a priority or add someone else as a maintainer to get this resolved? I'd be happy to volunteer, and I'm sure others would be as well.

kcrawford

Approving this to more forward with Swift Package Manager. I expect some issues but we'll work through them.

kcrawford · 2023-10-29T20:06:40Z

Sorry for all the delays. Wanted to be sure I could support this going forward.

chenrui333 · 2023-10-29T23:18:01Z

@kcrawford can you cut a new release as well? Thanks! 🙏

Kyle-Ye · 2023-10-30T04:02:12Z

Approving this to more forward with Swift Package Manager. I expect some issues but we'll work through them.

If there are items I could help, feel free to assign it to me.

straxhaber · 2023-11-02T14:42:36Z

@kcrawford First of all, thank you for merging this. So that all of us home-brew users can use your fantastic tool through that, would you mind cutting a new release? Homebrew usually indexes off of releases rather than HEAD. It looks like @chenrui333 created a separate issue for this. #158

kcrawford · 2023-11-02T16:52:22Z

I have to figure out how I want to build, sign, notarize the .pkg with the change. I think if I do a release without a pkg it may break autopkg recipes or other automation scripts looking for a pkg associated with the release.

straxhaber · 2023-11-03T22:49:52Z

I have to figure out how I want to build, sign, notarize the .pkg with the change. I think if I do a release without a pkg it may break autopkg recipes or other automation scripts looking for a pkg associated with the release.

@kcrawford Thank you for explaining. Do you have an ETA on when this will be done?

@Kyle-Ye @chenrui333 @rgl do any of you have advice on how to do this? Perhaps you can help @kcrawford if you know.

kcrawford · 2023-12-16T22:34:41Z

Working on a new release but noticed my Apple Developer subscription expired. Wanted to let folks know that you or your company can contribute to this project using the sponsor button.

Regardless I hope to have a release out soon.

straxhaber · 2024-01-01T02:14:15Z

@kcrawford Thank you so much for getting this done!

Add Swift Package support

e854ca9

Kyle-Ye force-pushed the spm branch from f9f5d10 to 04c6937 Compare April 5, 2022 17:20

Kyle-Ye commented Apr 5, 2022

View reviewed changes

sashkab mentioned this pull request Apr 21, 2022

dockutil 3.0.0 build issue #122

Closed

branchvincent mentioned this pull request May 14, 2022

dockutil 3.0.2 Homebrew/homebrew-core#97394

Closed

6 tasks

phinze mentioned this pull request Feb 13, 2023

Homebrew formula is not up-to-date #146

Closed

kcrawford self-requested a review March 27, 2023 00:44

kcrawford marked this pull request as draft March 27, 2023 00:48

Kyle-Ye added 2 commits April 3, 2023 21:24

Update file structure to standard swift package

98fe678

Fix SPM warning

1f4aff2

Kyle-Ye force-pushed the spm branch from 04c6937 to 1f4aff2 Compare April 3, 2023 13:27

Remove xcodeproj support

230aca0

Kyle-Ye force-pushed the spm branch from 8dec879 to 230aca0 Compare April 3, 2023 14:49

Kyle-Ye marked this pull request as ready for review April 4, 2023 02:57

rgl mentioned this pull request Jun 24, 2023

PoC: Add GitHub actions workflow #152

Draft

kcrawford approved these changes Oct 29, 2023

View reviewed changes

kcrawford merged commit 15f1617 into kcrawford:main Oct 29, 2023

Kyle-Ye deleted the spm branch October 30, 2023 04:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Swift Package Manager support #131

Add Swift Package Manager support #131

Kyle-Ye commented Apr 5, 2022 •

edited

Loading

Kyle-Ye Apr 5, 2022

Kyle-Ye commented May 18, 2022

mathbunnyru commented Jul 30, 2022

ashtonian commented Oct 31, 2022

sroberts commented Jan 14, 2023

TheNite commented Feb 27, 2023

Austin1 commented Mar 19, 2023

sroberts commented Mar 20, 2023

Kyle-Ye commented Mar 20, 2023

kcrawford commented Mar 20, 2023

Kyle-Ye commented Mar 20, 2023

kcrawford commented Mar 27, 2023

Kyle-Ye commented Mar 27, 2023

kcrawford commented Mar 27, 2023 •

edited

Loading

Kyle-Ye commented Apr 3, 2023

rgl commented Jun 24, 2023 •

edited

Loading

ChrisCarini commented Jun 29, 2023

booch commented Sep 26, 2023 •

edited

Loading

straxhaber commented Oct 1, 2023

Kyle-Ye commented Oct 2, 2023 •

edited

Loading

kcrawford commented Oct 11, 2023

straxhaber commented Oct 17, 2023

kcrawford left a comment

kcrawford commented Oct 29, 2023

chenrui333 commented Oct 29, 2023

Kyle-Ye commented Oct 30, 2023

straxhaber commented Nov 2, 2023 •

edited

Loading

kcrawford commented Nov 2, 2023

straxhaber commented Nov 3, 2023

kcrawford commented Dec 16, 2023

straxhaber commented Jan 1, 2024

Add Swift Package Manager support #131

Add Swift Package Manager support #131

Conversation

Kyle-Ye commented Apr 5, 2022 • edited Loading

Kyle-Ye Apr 5, 2022

Choose a reason for hiding this comment

Kyle-Ye commented May 18, 2022

mathbunnyru commented Jul 30, 2022

ashtonian commented Oct 31, 2022

sroberts commented Jan 14, 2023

TheNite commented Feb 27, 2023

Austin1 commented Mar 19, 2023

sroberts commented Mar 20, 2023

Kyle-Ye commented Mar 20, 2023

kcrawford commented Mar 20, 2023

Kyle-Ye commented Mar 20, 2023

kcrawford commented Mar 27, 2023

Kyle-Ye commented Mar 27, 2023

kcrawford commented Mar 27, 2023 • edited Loading

Kyle-Ye commented Apr 3, 2023

rgl commented Jun 24, 2023 • edited Loading

ChrisCarini commented Jun 29, 2023

booch commented Sep 26, 2023 • edited Loading

straxhaber commented Oct 1, 2023

Kyle-Ye commented Oct 2, 2023 • edited Loading

kcrawford commented Oct 11, 2023

straxhaber commented Oct 17, 2023

kcrawford left a comment

Choose a reason for hiding this comment

kcrawford commented Oct 29, 2023

chenrui333 commented Oct 29, 2023

Kyle-Ye commented Oct 30, 2023

straxhaber commented Nov 2, 2023 • edited Loading

kcrawford commented Nov 2, 2023

straxhaber commented Nov 3, 2023

kcrawford commented Dec 16, 2023

straxhaber commented Jan 1, 2024

Kyle-Ye commented Apr 5, 2022 •

edited

Loading

kcrawford commented Mar 27, 2023 •

edited

Loading

rgl commented Jun 24, 2023 •

edited

Loading

booch commented Sep 26, 2023 •

edited

Loading

Kyle-Ye commented Oct 2, 2023 •

edited

Loading

straxhaber commented Nov 2, 2023 •

edited

Loading