xcode-build-server: new port #22707

woolsweater · 2024-02-18T04:33:34Z

Description

xcode-build-server provides a Build Server Protocol implementation that allows sourcekit-lsp to be used with Xcode projects. It recently published a v1.0.0 release.

Type(s)

bugfix
enhancement
security fix

Tested on

macOS 13.6.1 22G313 arm64
Xcode 15.0.1 15A507

macOS 13.6.3 22G436 arm64
Xcode 15.2 15C500b

Verification

Have you

followed our Commit Message Guidelines?
squashed and minimized your commits?
checked that there aren't other open pull requests for the same change?
checked your Portfile with port lint --nitpick?
tried a full install with sudo port -vst install?
tested basic functionality of all binary files?
checked that the Portfile's most important variants haven't been broken?

pmetzger

Thanks so much for the submission! A couple of comments.

pmetzger · 2024-02-18T19:06:43Z

devel/xcode-build-server/Portfile

+PortGroup           python 1.0
+
+github.setup        SolaWing xcode-build-server 1.0.0 v
+name                xcode-build-server


I believe this is the default given that it's the same as the github.setup.

pmetzger · 2024-02-18T19:06:47Z

devel/xcode-build-server/Portfile

+                    sha256  08ea2b9a892670bb7c2f8ff90a97ae0be519744f42ba713bb1a56e247c77e885 \
+                    size    18673
+
+python.default_version      39


Our default version of python now is 3.12, can this package use it?

Yes, that should be fine. I included this because it's the lowest version that xcode-build-server says it supports; I wasn't sure how MacPorts preferred to handle that. I will change this.

pmetzger · 2024-02-18T19:07:37Z

@reneeotten Not sure if you want to have a quick look too.

reneeotten

a few comments but I am not behind a computer, so can't check much.

reneeotten · 2024-02-18T19:51:40Z

devel/xcode-build-server/Portfile

+version             1.0.0
+revision            0
+platforms           {darwin}
+license             MIT


"darwin" is the default but if this is the "usual" Python it could be "{darwin any} if it installs the same files on each OS version. Otherwise, then line can be removed.

if it only install Python files, then it should become "platforms {darwin any}

The project is only useful on a platform where Xcode is available, so any seems inappropriate.

no, it isn't {darwin any} just means that the installed files will be the same on all macOS versions, which is the case here. See the description in the guide - here.

I see, I misunderstood the syntax. So this should probably be {macosx any} then, since I don't think Xcode is usable on plain Darwin.

reneeotten · 2024-02-18T19:52:26Z

devel/xcode-build-server/Portfile

+supported_archs     noarch
+
+homepage            https://github.com/SolaWing/xcode-build-server
+


this is the default set by the "github" PortGroup, please remove

reneeotten · 2024-02-18T19:53:03Z

devel/xcode-build-server/Portfile

+build {}
+
+destroot {
+    set libdir ${destroot}${prefix}/lib/${name}


we usually don't want to override any phases - is there nothing to be build for this package?

No, it's just a group of 7 Python files which import each other, and one of which (named xcode-build-server) is the frontend to the tool. It does not use setuptools or any kind of build script.

that's great packaging by upstream....

Anyway, I see that the shebang line read: #!/usr/bin/env python3, that is certainly not correct as here you are installing it for MacPorts' version of Python 3.12. So that line in at least the xcode-build-server file will need to be changed in a post-patch phase.

reneeotten · 2024-02-18T20:25:00Z

devel/xcode-build-server/Portfile

+build {}
+
+destroot {
+    set libdir ${destroot}${prefix}/lib/${name}


that's great packaging by upstream....

Anyway, I see that the shebang line read: #!/usr/bin/env python3, that is certainly not correct as here you are installing it for MacPorts' version of Python 3.12. So that line in at least the xcode-build-server file will need to be changed in a post-patch phase.

reneeotten · 2024-02-18T20:28:06Z

devel/xcode-build-server/Portfile

+    set libdir ${destroot}${prefix}/lib/${name}
+    set binpath ${destroot}${prefix}/bin/${name}
+    xinstall -d -m 0755 ${libdir}
+    xinstall -m 0755 {*}[glob ${worksrcpath}/*.py] ${libdir}


the Python "library" files should ideally go into something like python.pkgd (see here) with the package-name included instead of just dumping them in ${prefix}/lib/name.

reneeotten · 2024-02-18T20:30:17Z

devel/xcode-build-server/Portfile

+    xinstall -d -m 0755 ${libdir}
+    xinstall -m 0755 {*}[glob ${worksrcpath}/*.py] ${libdir}
+    xinstall -m 0755 -W ${worksrcpath} ${name} ${libdir}
+    file link -symbolic ${binpath} ../lib/${name}/${name}


the xcode-build-server script should probably not be installed in ${libdir} and then linked, but just directly in ${binpath}?

Since it imports the other files by their bare names (e.g. import config) I believe it needs to be physically located next to them.

pmetzger · 2024-02-21T16:52:55Z

CI is now failing. We should fix that and then I think we can merge.

woolsweater · 2024-02-21T17:14:19Z

CI is now failing. We should fix that and then I think we can merge.

Thanks @pmetzger; it does not appear to me that the failure had anything to do with the new Portfile: https://github.com/macports/macports-ports/actions/runs/7951916696/job/21705909092?pr=22707 I just pushed an empty change to try to re-trigger the checks but they seem to have been skipped entirely. Is it possible for you to trigger them?

woolsweater · 2024-02-22T00:08:20Z

Is it possible for you to trigger them?

Never mind; I added a bit to the commit message and pushed that.

reneeotten · 2024-02-22T00:23:56Z

devel/xcode-build-server/Portfile

+build {}
+
+post-patch {
+    reinplace "s|#!/usr/bin/env python3|#!/usr/bin/env python${python.branch}|" \


please do the reinplace to change it to "${python.bin}"

${python.bin} results in #!/usr/bin/env python/opt/local/Library/Frameworks/Python.framework/Versions/3.12/bin/python3.12, which doesn't execute.

what I mean is that you should replace "/usr/bin/env python3" with "{python.bin}", that will work

Okay, got it.

so, this should become:

post-patch { reinplace "s|/usr/bin/env python3|${python.bin}|" ${worksrcpath}/${name} }

reneeotten · 2024-02-22T00:26:26Z

devel/xcode-build-server/Portfile

+
+destroot {
+    set pkgdir [string replace ${python.pkgd} 0 [string length ${prefix}]]/${name}
+    set destpkgdir ${destroot}${prefix}/${pkgdir}


creating two new variables here seem unnecessary. I can take a look later tonight when I am behind a computer; this should be doable with variables that are already defined in the "python" PortGroup.

I was unable to find a suitable predefined variable but I would be happy to take your suggestions. 👍

the destroot section should become:

destroot { xinstall -d ${destroot}/${python.pkgd}/${name} xinstall -m 0755 {*}[glob ${worksrcpath}/*.py] ${destroot}/${python.pkgd}/${name} xinstall -m 0755 -W ${worksrcpath} ${name} ${destroot}/${python.pkgd}/${name} ln -s ${python.pkgd}/${name}/${name} ${destroot}${prefix}/bin/${name} }

Done. So that I understand for next time, would you mind letting me know why repeating the literal ${destroot}/${python.pkgd}/${name} is preferable to making a variable for it and using that?

reneeotten

@woolsweater please take a look at the suggested changes, with these it appears to me that everything is working as intended. Please verify and if that's the case make the changes and push to this PR.

woolsweater · 2024-02-22T03:30:23Z

@woolsweater please take a look at the suggested changes, with these it appears to me that everything is working as intended. Please verify and if that's the case make the changes and push to this PR.

Done.

`xcode-build-server` provides a Build Server Protocol implementation that allows `sourcekit-lsp` to be used with Xcode projects. The project does not provide an install script or configuration, so the files must be manually moved into appropriate locations.

woolsweater · 2024-02-24T22:35:56Z

Thanks, @reneeotten !

macportsbot added type: enhancement type: submission labels Feb 18, 2024

pmetzger reviewed Feb 18, 2024

View reviewed changes

woolsweater force-pushed the add-xcode-build-server branch from b92ae82 to 811f8a0 Compare February 18, 2024 19:39

reneeotten requested changes Feb 18, 2024

View reviewed changes

woolsweater force-pushed the add-xcode-build-server branch from 811f8a0 to 56e885e Compare February 18, 2024 20:09

reneeotten requested changes Feb 18, 2024

View reviewed changes

woolsweater force-pushed the add-xcode-build-server branch from 56e885e to 2ed10d9 Compare February 18, 2024 21:47

woolsweater force-pushed the add-xcode-build-server branch from 2ed10d9 to e6d42ca Compare February 21, 2024 17:10

woolsweater force-pushed the add-xcode-build-server branch from e6d42ca to 35bbb86 Compare February 21, 2024 23:09

reneeotten requested changes Feb 22, 2024

View reviewed changes

woolsweater force-pushed the add-xcode-build-server branch from 35bbb86 to b13979b Compare February 22, 2024 03:29

xcode-build-server: new port

af79d2d

`xcode-build-server` provides a Build Server Protocol implementation that allows `sourcekit-lsp` to be used with Xcode projects. The project does not provide an install script or configuration, so the files must be manually moved into appropriate locations.

woolsweater force-pushed the add-xcode-build-server branch from b13979b to af79d2d Compare February 22, 2024 03:34

reneeotten merged commit d92e3ab into macports:master Feb 24, 2024
4 checks passed

woolsweater mentioned this pull request Feb 24, 2024

xcode-build-server has been added to MacPorts SolaWing/xcode-build-server#41

Closed

		supported_archs noarch

		homepage https://github.com/SolaWing/xcode-build-server

xcode-build-server: new port #22707

xcode-build-server: new port #22707

Conversation

woolsweater commented Feb 18, 2024

Description

Type(s)

Tested on

Verification

pmetzger left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pmetzger commented Feb 18, 2024

reneeotten left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

woolsweater Feb 22, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

woolsweater Feb 18, 2024 • edited

Choose a reason for hiding this comment

pmetzger commented Feb 21, 2024

woolsweater commented Feb 21, 2024

woolsweater commented Feb 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

woolsweater Feb 22, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

reneeotten left a comment

Choose a reason for hiding this comment

woolsweater commented Feb 22, 2024

woolsweater commented Feb 24, 2024

woolsweater Feb 22, 2024 •

edited

woolsweater Feb 18, 2024 •

edited

woolsweater Feb 22, 2024 •

edited