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.

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

docs: added section on e load-xcode and how to fix security error #444

Closed

Conversation

mccare
Copy link

@mccare mccare commented Dec 20, 2022

I was running into error when e init was downloading and installing Xcode.app. The error was pretty confusing, so I tried to document it in the Readme.

Screenshot 2022-12-20 at 18 10 55

Screenshot 2022-12-20 at 18 10 59

Screenshot 2022-12-20 at 18 11 12

@@ -434,3 +440,5 @@ Regardless of whether automatic updates are enabled, you can manually call the f
```
e auto-update check
```

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not add this extra space here please!

@@ -386,6 +386,12 @@ $ e sanitize-config --help

Sometimes `build-tools` will make updates to its config requirements. In these events warnings will be output to console to inform you that `build-tools` has temporarily handled the issues. You can make these warnings go away either by manually updating your config files or by running this command to automatically overwrite the existing configs to update formatting.

### `e load-xcode`
`e load-xcode` downloads and unpacks Xcode and required macOS SDK into the electron buildtools (`.electron_build_tools`) directory
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Space between header and top description please!

`e load-xcode` downloads and unpacks Xcode and required macOS SDK into the electron buildtools (`.electron_build_tools`) directory
and symlinks them. This is automatically run by `e init`.

In case you get a pop up saying that "Xcode is damaged", you need to acknowledge the dialog with cancel and open it through system preferences. Go to System Preferences/Security & Privacy. There will be a section stating that "Xcode is from an unidentified developer". Press "Open Anyway" to acknowledge that you want to open Xcode.app. You might want to run `e load-xcode` again.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's tweak the wording of this:

As of some more recent Xcode releases, you may see a popup dialog saying "Xcode is damaged". If this occurs, you will need to acknowledge the dialog with cancel and open it through macOS System Preferences. Go to the Security & Privacy section within System Preferences. There will be a section stating "Xcode is from an unidentified developer". Press "Open Anyway" to acknowledge that you want to open Xcode.app. Following this, run the e load-xcode command again to verify it works as expected.


Copy link
Member

@MarshallOfSound MarshallOfSound left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't show up on M1 based macs and isn't the correct solution afaik. Folks need to add their terminal application (normally Terminal or iTerm to the list of Developer Tools in their privacy settings on their mac)

@mccare
Copy link
Author

mccare commented Jun 6, 2023

Good point, I'm using Kitty.app and it is not listed in my developer tools. So this is pretty specific to my setup and doesn't warrant more documentation. Feel free to close it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants