MacOS: 📝 Add warning on how to install geol on macos#306
MacOS: 📝 Add warning on how to install geol on macos#306Supervinh merged 1 commit intoopt-nc:developfrom
Conversation
adriens
added
RUN
|
LGTM |
|
There is CI issue @Supervinh that comes from |
|
My advice would be to force the merge but I don't really feel happy about that 🤔 |
adriens
changed the title
|
@copilot can you take a look athe lint issue in the ci ? |
There was a problem hiding this comment.
Pull request overview
Updates the README to improve section heading structure and add macOS-specific guidance for running an unsigned geol binary installed via Homebrew.
Changes:
- Normalize several README section headers to
##for consistent hierarchy. - Add a macOS warning/advice block about Gatekeeper/quarantine when running
geolinstalled via Homebrew. - Minor whitespace/formatting adjustments in the README.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| > For macos users, you will have to allow the execution of `geol` in your security settings, as it is not signed with an Apple Developer account. You can do this by going to `System Preferences > Security & Privacy > General` and clicking on `Allow Anyway` for `geol`. | ||
| > or you can run the following command in your terminal to allow the execution of `geol`: | ||
| >```sh | ||
| >xattr -d com.apple.quarantine $(which geol) |
There was a problem hiding this comment.
The macOS instructions look outdated and slightly inconsistent: macOS is typically capitalized as “macOS”, and newer versions use “System Settings > Privacy & Security” (not “System Preferences > Security & Privacy > General”). Consider wording that covers both, and start the second sentence with “Or …” (capital O).
| > For macos users, you will have to allow the execution of `geol` in your security settings, as it is not signed with an Apple Developer account. You can do this by going to `System Preferences > Security & Privacy > General` and clicking on `Allow Anyway` for `geol`. | |
| > or you can run the following command in your terminal to allow the execution of `geol`: | |
| >```sh | |
| >xattr -d com.apple.quarantine $(which geol) | |
| > For macOS users, you may need to allow the execution of `geol` in your security settings, as it is not signed with an Apple Developer account. You can do this by going to `System Settings > Privacy & Security` (or on older versions, `System Preferences > Security & Privacy > General`) and clicking on `Allow Anyway` for `geol`. | |
| > Or you can run the following command in your terminal to allow the execution of `geol`: | |
| >```sh | |
| >xattr -d com.apple.quarantine "$(which geol)" |
| > For macos users, you will have to allow the execution of `geol` in your security settings, as it is not signed with an Apple Developer account. You can do this by going to `System Preferences > Security & Privacy > General` and clicking on `Allow Anyway` for `geol`. | ||
| > or you can run the following command in your terminal to allow the execution of `geol`: | ||
| >```sh | ||
| >xattr -d com.apple.quarantine $(which geol) |
There was a problem hiding this comment.
The suggested command uses $(which geol) unquoted. For robustness (and to avoid which quirks), prefer command -v and quote the substitution so it behaves correctly even if the resolved path contains spaces; also consider handling the case where the command isn’t found.
| >xattr -d com.apple.quarantine $(which geol) | |
| >geol_path="$(command -v geol)" && xattr -d com.apple.quarantine "$geol_path" |
| > For macos users, you will have to allow the execution of `geol` in your security settings, as it is not signed with an Apple Developer account. You can do this by going to `System Preferences > Security & Privacy > General` and clicking on `Allow Anyway` for `geol`. | ||
| > or you can run the following command in your terminal to allow the execution of `geol`: | ||
| >```sh | ||
| >xattr -d com.apple.quarantine $(which geol) | ||
| >``` |
There was a problem hiding this comment.
Removing the com.apple.quarantine attribute bypasses Gatekeeper checks. The README should include a short caution that users should only do this if they trust the downloaded binary, and consider linking to an official Apple reference or offering the “right‑click > Open” flow as the safer default.
| > For macos users, you will have to allow the execution of `geol` in your security settings, as it is not signed with an Apple Developer account. You can do this by going to `System Preferences > Security & Privacy > General` and clicking on `Allow Anyway` for `geol`. | |
| > or you can run the following command in your terminal to allow the execution of `geol`: | |
| >```sh | |
| >xattr -d com.apple.quarantine $(which geol) | |
| >``` | |
| > On macOS, `geol` is not currently signed with an Apple Developer account, so you may need to explicitly allow it to run. The **recommended** way is to go to `System Settings > Privacy & Security` (or `System Preferences > Security & Privacy > General` on older macOS versions) and click **"Open Anyway"** for `geol`, or right-click the binary in Finder and choose **Open**. | |
| > Alternatively, you can remove the quarantine attribute with the following command: | |
| >```sh | |
| >xattr -d com.apple.quarantine $(which geol) | |
| >``` | |
| > This command bypasses macOS Gatekeeper checks and should **only** be used if you fully trust the downloaded binary. For more details, see Apple’s documentation on safely opening apps from unidentified developers: https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac |
| >```sh | ||
| >xattr -d com.apple.quarantine $(which geol) | ||
| >``` |
There was a problem hiding this comment.
Markdown formatting nit: inside the blockquote, add a space after > before the fenced code block markers (e.g., > ```sh / `> ````). This tends to render more reliably across Markdown parsers and improves readability.
| >```sh | |
| >xattr -d com.apple.quarantine $(which geol) | |
| >``` | |
| > ```sh | |
| > xattr -d com.apple.quarantine $(which geol) | |
| > ``` |
| ## 🤓 Build it yourself | ||
|
|
||
| To build it youself : | ||
| To build it youself : |
There was a problem hiding this comment.
Spelling/grammar: “To build it youself :” has a typo (“youself” → “yourself”) and the extra space before the colon is non-standard in English. Similar space-before-colon appears in other sentences in this README; consider fixing them consistently.
|
Trying something with |
|
Waiting for to be merged |
|
Hey @lschaeffer313 , it should be good to update your branch now |
|
Thanks @Supervinh for the heads up. |
|
Congrats on merging your first pull request! |
|
merci @lschaeffer313 💋 |
|
Hopefully you'll find geol useful in your daily projects 🙌 @lschaeffer313 |
No description provided.