Skip to content

Commit 9d3dcb2

Browse files
committed
Doc snippets
1 parent f17abc0 commit 9d3dcb2

File tree

4 files changed

+34
-0
lines changed

4 files changed

+34
-0
lines changed
File renamed without changes.

docs/IOS_DEV_SETUP.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# iOS Dev Setup
2+
3+
To use the published Xcode Framework, you'll need to integrate it into your Xcode project. You'll also need to understand how to add authentication information, if required by your artifact storage.
4+
5+
For developers editing Kotlin, you will want to test locally-built Kotlin code directly in your Xcode project from time to time. How that works differs depending on which dependency manager you use. For Cocoapods see [IOS_LOCAL_DEV_COCOAPODS](IOS_LOCAL_DEV_COCOAPODS.md). For SPM see [IOS_LOCAL_DEV_SPM](IOS_LOCAL_DEV_SPM.md).
6+
7+
## Private Github Releases
8+
9+
If you are using private Github artifacts, you'll need to add auth info for that to work. See [GITHUB_RELEASE_ARTIFACTS](GITHUB_RELEASE_ARTIFACTS.md#private-repos).
10+
11+
*You must do this before attempting to integrate dependency managers!!!*
12+
13+
## Using Cocoapods
14+
15+
* Add spec repo
16+
* Add module to Podfile
17+
* Make sure to specify versions such that 'pod update' gets new versions (optimistic operator) https://guides.cocoapods.org/using/the-podfile.html
18+
19+
## Using SPM
20+
21+
* Add Packages, use GIthub
22+
* Select "Up to next major version"
23+

docs/IOS_LOCAL_DEV_COCOAPODS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
General outline
2+
3+
* Pass in env var
4+
* Run pod whatever (pod install, maybe clean local dir)
5+
*

docs/IOS_LOCAL_DEV_SPM.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
general outline
2+
3+
* SPM wants the Package.swift file at top level in the repo
4+
* Run ./gradlew assmble... (whatever the task is called) to build local (we're going to improve this later, but for now just document)
5+
* Drag whole folder in. Point out that the module that was shown in project navigator should "disappear"
6+
* Strong reminder to remove before committing. State we are thinking through commit checks to prevent this

0 commit comments

Comments
 (0)