apple / swift-openapi-generator

Generate Swift client and server code from an OpenAPI document.
https://swiftpackageindex.com/apple/swift-openapi-generator/documentation
Apache License 2.0
1.45k stars 120 forks source link

[Docs] Explain how to enable plugins in Xcode and Xcode Cloud #653

Closed czechboy0 closed 1 month ago

czechboy0 commented 1 month ago

Motivation

By default, adopters hit this error both in Xcode and Xcode Cloud and might not be familiar with how to resolve it.

Modifications

Expand the FAQ to cover how to enable plugins in Xcode and Xcode Cloud.

Result

Better docs, adopters can find a solution easier.

Test Plan

N/A

theoriginalbit commented 1 month ago

It's potentially worth adding a comment to the script to point out that the misspelling of validation in the plist key is "correct" as Xcode Cloud/Xcode expects it.

I've had many devs before try to "fix" the typo and then wonder why it doesn't work.

simonjbeaumont commented 1 month ago

It's potentially worth adding a comment to the script to point out that the misspelling of validation in the plist key is "correct" as Xcode Cloud/Xcode expects it.

I've had many devs before try to "fix" the typo and then wonder why it doesn't work.

Ha! Nice spot. I'm slightly embarrassed that, while I've used this many times, I never even noticed :)

Yes, if you open a PR, we'd take it.

theoriginalbit commented 1 month ago

Ha! Nice spot. I'm slightly embarrassed that, while I've used this many times, I never even noticed :)

I'd like to take credit for noticing it, but all the credit has to go to the spell checker. :D I have it turned on in Xcode, so it points out spelling mistakes to me all the time.