docs(ios): add compatibility notes for xcodegen (#816)

MarathonLabs · Jul 15, 2023 · 1f4905b · 1f4905b
1 parent 4d56c4f
commit 1f4905b
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/docs/docs/ios.md b/docs/docs/ios.md
@@ -19,9 +19,22 @@ It is much easier to supply the `.app` application bundle and `.xctest` bundle d
 archive and depending on runtime discovery of your bundles
 
 :::
+
+## Compatibility notes
+### XcodeGen
+For users of [XcodeGen][5] marathon requires you to specify the following in your project's spec to make sure Info.plist is generated for parsing your app's information:
+
+```yaml
+settings:
+  GENERATE_INFOPLIST_FILE: YES
+```
+
+See [XcodeGen docs][6] for more information.
  
 
 [1]: ios/workers.md
 [2]: https://en.wikipedia.org/wiki/Secure_Shell
 [3]: https://en.wikipedia.org/wiki/Rsync
 [4]: https://en.wikipedia.org/wiki/.ipa
+[5]: https://github.com/yonaskolb/XcodeGen
+[6]: https://github.com/yonaskolb/XcodeGen/blob/a9ed3cec0800ac9a8b4cd5cfb0bb3ee76429a22c/Docs/ProjectSpec.md
diff --git a/docs/versioned_docs/version-0.8.0/ios.md b/docs/versioned_docs/version-0.8.0/ios.md
@@ -19,9 +19,22 @@ It is much easier to supply the `.app` application bundle and `.xctest` bundle d
 archive and depending on runtime discovery of your bundles
 
 :::
+
+## Compatibility notes
+### XcodeGen
+For users of [XcodeGen][5] marathon requires you to specify the following in your project's spec to make sure Info.plist is generated for parsing your app's information:
+
+```yaml
+settings:
+  GENERATE_INFOPLIST_FILE: YES
+```
+
+See [XcodeGen docs][6] for more information.
  
 
 [1]: ios/workers.md
 [2]: https://en.wikipedia.org/wiki/Secure_Shell
 [3]: https://en.wikipedia.org/wiki/Rsync
 [4]: https://en.wikipedia.org/wiki/.ipa
+[5]: https://github.com/yonaskolb/XcodeGen
+[6]: https://github.com/yonaskolb/XcodeGen/blob/a9ed3cec0800ac9a8b4cd5cfb0bb3ee76429a22c/Docs/ProjectSpec.md