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: add Rosetta Simulator Instructions #4599

Merged
merged 7 commits into from
Dec 9, 2024

Conversation

kagrawal98
Copy link
Contributor

@kagrawal98 kagrawal98 commented Oct 6, 2024

Description

Fixes #4571

This PR adds a new section to the "Building the App" troubleshooting guide, specifically addressing issues that may arise when running Detox in a Rosetta environment on Apple Silicon Macs.

  • Added a new subsection titled "Running Detox in a Rosetta environment"
  • Provided step-by-step instructions to resolve SwiftEmitModule or SwiftCompile errors
  • Included code snippets for modifying the Detox configuration and running necessary terminal commands

Why is this important?

As more developers transition to Apple Silicon Macs, it's crucial to provide guidance on running tools like Detox in Rosetta environments. This addition will help users troubleshoot and resolve common issues, improving their development experience.


For features/enhancements:

  • I have added/updated the relevant references in the documentation files.

For API changes:

  • I have made the necessary changes in the types index file.

@kagrawal98 kagrawal98 requested a review from d4vidi as a code owner October 6, 2024 09:33
@kagrawal98 kagrawal98 changed the title chore: Add Rosetta Simulator Instructions docs: Add Rosetta Simulator Instructions Oct 6, 2024
@kagrawal98 kagrawal98 changed the title docs: Add Rosetta Simulator Instructions docs: add Rosetta Simulator Instructions Oct 6, 2024
@d4vidi
Copy link
Collaborator

d4vidi commented Oct 6, 2024

Thanks a lot, @kagrawal98! Are you and @differenzPriv aligned on the solution?

@d4vidi
Copy link
Collaborator

d4vidi commented Oct 6, 2024

In any case, you seem to have edited the document in the wrong path. Should be easy to fix.
As per content, @asafkorem - WDYT?

@d1fferenz
Copy link

d1fferenz commented Oct 6, 2024

In any case, you seem to have edited the document in the wrong path. Should be easy to fix. As per content, @asafkorem - WDYT?

Thanks @d4vidi for tagging me and keeping me in the loop! I haven't forgotten to contribute to the repository in relation to the rosetta trouble shooting solution, but my time has been quite limited over the past few weeks.

I agree with the addition @kagrawal98 made to the README. The solution includes all the key elements needed to solve the problem. 👍🏻

@d4vidi
Copy link
Collaborator

d4vidi commented Oct 7, 2024

I agree with the addition @kagrawal98 made to the README. The solution includes all the key elements needed to solve the problem. 👍🏻

@differenzPriv thanks, that's what I needed to know

@asafkorem
Copy link
Contributor

@kagrawal98, you've edited the snapshotted version of building-the-app.md (Detox v20). Please edit the most up-to-date document instead (under docs/troubleshooting/building-the-app.md)

@asafkorem asafkorem self-assigned this Oct 12, 2024
@kagrawal98 kagrawal98 requested a review from asafkorem November 29, 2024 07:51
@asafkorem asafkorem merged commit bf7ea88 into wix:master Dec 9, 2024
1 check passed
@asafkorem
Copy link
Contributor

Thanks @kagrawal98! Great contributions!

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.

Add Rosetta Simulator Instructions
4 participants