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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

More info for implement this action Readme #165

Merged
merged 2 commits into from Oct 9, 2023

Conversation

LucasGinard
Copy link
Contributor

Hi, thanks for providing this action 馃憦

I'd like to contribute by adding additional information on how to implement this action. When I was looking for a way to implement it in my project (using CocoaPods), I couldn't find clear instructions.

I tried implementing other actions, but they didn't work as expected. Then, I went back and searched in the issues to see if it could be used with CocoaPods. I found this issue, which provided a successful implementation.

That's why I'd like to contribute by adding an example of how to implement it with CocoaPods.

Add info for compatibility and example for implement with cocoapods
@ffried
Copy link
Member

ffried commented Oct 9, 2023

@LucasGinard Thanks for enhancing the documentation.
I've made some changes to your initial patch:

  • Removed the icon from the title
    • It's our company logo, not an icon specific to this action.
  • Removed the section describing compatibility
    • The compatibility for this action is simple: If you can use xcodebuild, you can use this action. I can this statement to the README, but I think it should be obvious. 馃槈
  • Removed the section describing the action input
    • As mentioned in the description for the action input in action.yml, this is the same as xcodebuilds action parameter. So as with all other inputs, the description for it can be found in man xcodebuild. I don't want to keep this README up to date with changes to how parameters of xcodebuild works. Also, we don't do any special input validation - we just pass it on to xcodebuild.
    • I did, however, add a note about man xcodebuild to the "Inputs" section.
  • I re-structured the "Examples" section into having three expandable details blocks: One for Swift packages, one for normal Xcode projects and one for workspaces. IMHO it's not required to have a special example for CocoaPods, since it simply uses workspaces.

@ffried ffried merged commit 27a7f3e into sersoft-gmbh:main Oct 9, 2023
26 checks passed
@LucasGinard LucasGinard deleted the patch-1 branch October 9, 2023 13:10
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.

None yet

2 participants