Skip to content

Commit

Permalink
docs: Emphasize target setting in Xcode tutorial (#58)
Browse files Browse the repository at this point in the history
### Motivation

In our Xcode tutorial we outline the steps to enable Swift OpenAPI
Generator on a separate framework. When you come to add the package
dependencies on the runtime and transport libraries the default target
Xcode offers to add them to is not this new framework. Failing to add
them to the framework target causes linker issues.

This is implied in our guide but it's pretty subtle and a user tripped
up over this.

### Modifications

- Emphasize which target the libraries need to be added to in the Xcode
tutorial.

### Result

Hopefully clearer step in the tutorial. 

### Test Plan

Ran through the steps manually and confirmed this generates a building
app.

### Resolves

Resolves #57.

Signed-off-by: Si Beaumont <[email protected]>
  • Loading branch information
simonjbeaumont authored Jun 9, 2023
1 parent 37255b7 commit 6aae3f5
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@
@Step {
Repeat the same steps two more times, with the packages `https://github.com/apple/swift-openapi-runtime` and `https://github.com/apple/swift-openapi-urlsession`.

This time do check the library products to be added to the GeneratedClient target.
This time, do check the library products to be added to the **GeneratedClient target**. Note, this might not be the default target Xcode offers to add the libraries to.
}
@Step {
To finish configuring the build plugin in your target, navigate to the Build Phases tab of the GeneratedClient in the Project Editor, and expand the Run Build Tool Plug-ins section.
Expand Down

0 comments on commit 6aae3f5

Please sign in to comment.