Add Mac OS build setup steps #287

kyle-rader · 2018-09-20T21:41:21Z

These steps are the outcome of getting a working build on a Mac pro (Late 2013) with a freshly installed

macOS High Sierra 10.13.6

Updates:

Add a Build setup step to the main README.md
Remove the macOS sdk version from the ProjFS build scripts. (Because XCode merrrrrrr removes SDKs at will...)

Questions:

What to say about the Apple Developer/Cert Signing step?

nickgra

I'm not sure what to say about developer certificates, I find most open source projects skim over how to handle getting a certificate so this might be fine?

Readme.md

nickgra · 2018-09-20T23:00:09Z

Readme.md

+
+VFS for macOS is still in progress. You can build it, but this will not create a macOS VFS installer the same way the current Windows build will.
+
+* Ensure you have Xcode installed and have accepted the terms of use and launched Xcode at least once.


nit: Only use and one in this step. replace the first and with ,

nickgra

LGTM now, I'm curious to hear what Saeed has to say about the level of detail and certificate handling.

sanoursa

Thanks for putting this together! Mostly minor cleanup though we need to make sure we validate the build script changes a bit more. And keep in mind that you still have to kick off the Mac functional tests manually.

ProjFS.Mac/Scripts/Build.sh

sanoursa · 2018-09-21T16:36:27Z

Readme.md

 build will fail, and the second and subsequent builds will succeed. This is because the build requires a prebuild code generation step.
 For details, see the build script in the previous step.

 The installer can now be found at `C:\Repos\VFSForGit\BuildOutput\GVFS.Installer\bin\x64\[Debug|Release]\SetupGVFS.<version>.exe`

+## Building VFS for Git on Mac
+
+VFS for macOS is still in progress. You can build it, but this will not create a macOS VFS installer the same way the current Windows build will.


We've been saying "VFS for Git on Mac", so stick with that for consistency. I'm open to feedback if it would be better to say "VFS for Git on macOS", but "VFS for macOS" is a whole different thing (https://developer.apple.com/library/archive/documentation/Darwin/Conceptual/KernelProgramming/Filesystem/Filesystem.html)

sanoursa · 2018-09-21T16:38:31Z

Readme.md

+
+* If you still do not have the `dotnet` cli `>= v2.1.300` installed [manually install it](https://www.microsoft.com/net/download/dotnet-core/2.1)
+
+* If you are not currently an Apple Developer you will need to become one so that you can either use Microsoft certs or create your own certs for signing purposes. (If you are a Microsoft employee you must use your alias@microsoft.com when creating your Apple account.)


I would remove all of this and instead point to a link for managing certs in Xcode. There's no reason for anyone to use Microsoft certs, nor do we want to open that up. For local development, people just need to generate their own cert and sign their kext, and that is all.

How is this as the resource to link to?

That page seems too high level on what a certificate is (we should point them to codesigning resources using certificates), this might be a better starting point https://developer.apple.com/support/code-signing/

In general, Xcode should be able to do all the right things for them once they're signed in.

sanoursa · 2018-09-21T16:38:54Z

Readme.md

+
+* If you are not currently an Apple Developer you will need to become one so that you can either use Microsoft certs or create your own certs for signing purposes. (If you are a Microsoft employee you must use your alias@microsoft.com when creating your Apple account.)
+
+* Create a `VFS` directory and Clone the VFS repo into a directory called `src` inside it:


There is no VFS repo :-). It's called VFSForGit.

Readme.md

sanoursa · 2018-09-21T16:41:26Z

Readme.md

+  gvfs clone URL_TO_REPOSITORY --local-cache-path ~/.gvfsCache
+  ```
+
+  Note the current use of `--local-cache-path`. That argument prevent gvfs from running into a permissions error trying to put the cache at the root of your Mac's hard-drive.


... because porting of this feature is still in progress

Scripts/Mac/PrepFunctionalTests.sh

sanoursa · 2018-09-21T16:43:50Z

Readme.md

+
+* Ensure you have Xcode installed and have accepted the terms of use and launched Xcode at least once.
+
+* Disable "System Integrity Protection" (for loading unsigned kexts) by booting into recovery mode (`[Win/⌘] + R` while booting).


You can't load an unsigned kext, period. Our kexts are not unsigned, they are just signed with developer certs.

Readme.md

sanoursa · 2018-09-21T16:45:27Z

Readme.md

+
+* Create a `VFS` directory and Clone the VFS repo into a directory called `src` inside it:
+  ```
+  mkdir VFS && cd VFS && git clone https://github.com/Microsoft/VFSForGit.git src && cd src


Please follow a similar style as the Windows section for the steps on how to clone and build.

Actually I'm not picky on what the style is, just that they be consistent.

sanoursa

I started reviewing this again but it looks like some of the earlier comments are still in progress. I'll stop here, and please let me know when you're ready for another look!

Readme.md

kyle-rader · 2018-09-26T20:09:38Z

@sanoursa @wilbaker Updated and rebased on master. Ready for re-review

sanoursa

Thanks for the cleanup, the steps look much clearer now. A few more style things, but most importantly, we need to be super clear about the dangers of disabling SIP. This is not something we are encouraging anyone to do, and it's just for now while we're doing active development that it's a necessary step, but it is most definitely a dangerous thing to do to any production machine.

sanoursa · 2018-09-26T20:37:56Z

Readme.md

+
+* Ensure you have Xcode installed, have accepted the terms of use, and have launched Xcode at least once.
+
+* Disable the "System Integrity Protection" (for loading unsigned Kexts) by booting into recovery mode (`[Win/⌘] + R` while booting).


There's no such thing as an unsigned kext. You can't even build it if you don't have your cert set up. What we do have are dev-signed kexts and production-signed kexts.

Also please don't capitalize kext.

sanoursa · 2018-09-26T20:38:44Z

Readme.md

+
+* Ensure you have Xcode installed, have accepted the terms of use, and have launched Xcode at least once.
+
+* Disable the "System Integrity Protection" (for loading unsigned Kexts) by booting into recovery mode (`[Win/⌘] + R` while booting).


We probably want a giant warning message here that this is a Very Bad Thing for the security of your machine. We are not recommending this on any production machine, ever. This is for development and testing only. Etc etc.

Readme.md

kyle-rader · 2018-10-04T19:36:12Z

@nickgra @sanoursa I've pushed resolutions to all remaining comments

sanoursa

Thanks for all the cleanup, I think this looks good!

nickgra

Thanks, looks good to me minus some phrasing nits.

Readme.md

kyle-rader requested review from sanoursa, wilbaker, kewillford and nickgra September 20, 2018 21:41

nickgra suggested changes Sep 20, 2018

View reviewed changes

Readme.md Outdated Show resolved Hide resolved

Readme.md Outdated Show resolved Hide resolved

Readme.md Outdated Show resolved Hide resolved

kyle-rader commented Sep 20, 2018

View reviewed changes

Readme.md Show resolved Hide resolved

kyle-rader requested a review from nickgra September 20, 2018 22:22

nickgra reviewed Sep 20, 2018

View reviewed changes

nickgra approved these changes Sep 20, 2018

View reviewed changes

sanoursa suggested changes Sep 21, 2018

View reviewed changes

sanoursa suggested changes Sep 24, 2018

View reviewed changes

Readme.md Outdated Show resolved Hide resolved

Readme.md Outdated Show resolved Hide resolved

Readme.md Outdated Show resolved Hide resolved

kyle-rader requested a review from sanoursa September 26, 2018 20:07

kyle-rader force-pushed the chore/add-mac-build-steps branch from 7385cd5 to 3f3c7cf Compare September 26, 2018 20:08

sanoursa suggested changes Sep 26, 2018

View reviewed changes

wilbaker reviewed Sep 26, 2018

View reviewed changes

Readme.md Outdated Show resolved Hide resolved

Readme.md Outdated Show resolved Hide resolved

Readme.md Outdated Show resolved Hide resolved

Readme.md Outdated Show resolved Hide resolved

Readme.md Outdated Show resolved Hide resolved

Readme.md Outdated Show resolved Hide resolved

nickgra suggested changes Sep 28, 2018

View reviewed changes

Readme.md Outdated Show resolved Hide resolved

Kyle Rader added 11 commits October 4, 2018 12:33

Add Mac Setup instructions needed for building on Mac

5ab4463

Add initial set of build steps for Mac OS

84fdbf8

Update mac os build subtitle

871f87c

Remove steps covered by the prep script

88b1c55

Remove deprecated java hack for git-credential-manager

fbc892a

Grammar

96218db

Style updates

54b7315

Simplify steps language

4fe765d

Update grammar issues

b824382

Fix Spelling

01b68ac

More style fixes

53f1def

kyle-rader force-pushed the chore/add-mac-build-steps branch from 40f42cf to 53f1def Compare October 4, 2018 19:33

kyle-rader requested a review from sanoursa October 4, 2018 19:35

kyle-rader requested a review from nickgra October 4, 2018 19:35

sanoursa approved these changes Oct 4, 2018

View reviewed changes

nickgra approved these changes Oct 4, 2018

View reviewed changes

Readme.md Outdated Show resolved Hide resolved

Readme.md Outdated Show resolved Hide resolved

Readme.md Outdated Show resolved Hide resolved

More grammar resolutions

04b9203

kyle-rader merged commit b613d4f into microsoft:master Oct 4, 2018

kyle-rader deleted the chore/add-mac-build-steps branch October 4, 2018 22:22

jrbriggs mentioned this pull request Oct 12, 2018

Merge milestones/M142 to releases/shipped #381

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Mac OS build setup steps #287

Add Mac OS build setup steps #287

kyle-rader commented Sep 20, 2018

nickgra left a comment

nickgra Sep 20, 2018

nickgra left a comment

sanoursa left a comment

sanoursa Sep 21, 2018

sanoursa Sep 21, 2018

kyle-rader Sep 21, 2018

nickgra Sep 21, 2018

sanoursa Sep 21, 2018

sanoursa Sep 21, 2018

sanoursa Sep 21, 2018

sanoursa Sep 21, 2018

sanoursa left a comment

kyle-rader commented Sep 26, 2018

sanoursa left a comment

sanoursa Sep 26, 2018

sanoursa Sep 26, 2018

kyle-rader commented Oct 4, 2018

sanoursa left a comment

nickgra left a comment •

edited

Loading


		VFS for macOS is still in progress. You can build it, but this will not create a macOS VFS installer the same way the current Windows build will.

		* Ensure you have Xcode installed and have accepted the terms of use and launched Xcode at least once.


		* If you still do not have the `dotnet` cli `>= v2.1.300` installed [manually install it](https://www.microsoft.com/net/download/dotnet-core/2.1)

		* If you are not currently an Apple Developer you will need to become one so that you can either use Microsoft certs or create your own certs for signing purposes. (If you are a Microsoft employee you must use your alias@microsoft.com when creating your Apple account.)


		* If you are not currently an Apple Developer you will need to become one so that you can either use Microsoft certs or create your own certs for signing purposes. (If you are a Microsoft employee you must use your alias@microsoft.com when creating your Apple account.)

		* Create a `VFS` directory and Clone the VFS repo into a directory called `src` inside it:


		* Ensure you have Xcode installed and have accepted the terms of use and launched Xcode at least once.

		* Disable "System Integrity Protection" (for loading unsigned kexts) by booting into recovery mode (`[Win/⌘] + R` while booting).


		* Ensure you have Xcode installed, have accepted the terms of use, and have launched Xcode at least once.

		* Disable the "System Integrity Protection" (for loading unsigned Kexts) by booting into recovery mode (`[Win/⌘] + R` while booting).

Add Mac OS build setup steps #287

Add Mac OS build setup steps #287

Conversation

kyle-rader commented Sep 20, 2018

nickgra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nickgra left a comment

Choose a reason for hiding this comment

sanoursa 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sanoursa left a comment

Choose a reason for hiding this comment

kyle-rader commented Sep 26, 2018

sanoursa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kyle-rader commented Oct 4, 2018

sanoursa left a comment

Choose a reason for hiding this comment

nickgra left a comment • edited Loading

Choose a reason for hiding this comment

nickgra left a comment •

edited

Loading