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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README with Swift Package support instructions. #74

Closed

Conversation

rr-james-hickman
Copy link
Contributor

Added instructions per request in #73

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
Comment on lines 124 to 125
* The important part to note is the use of `-scmProvider system` as it specifies SPM to use the current system's git configuration and **NOT** Xcode's.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Puh, it's really hard for me (as I have never used Swift) to judge this section.

My expectation was that this last line (add -scmProvider system to xcodebuild?) is all you need to know to make this action work.

I mean, isn't the rest about how to set up a private repo in the first place, something people already have when they use this action?

Also, this is only necessary when dealing with multiple deploy keys, right?

Copy link
Contributor Author

@rr-james-hickman rr-james-hickman Apr 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have moved and consolidated a bit. However, I personally feel like its helpful to have all the steps listed in one spot. It is not always clear what steps are all required, which is why it took 3 various articles (this documentation + an example in another issue + a StackOverflow post) before I was able to correctly get this working.

By listing here in one spot, future devs can hopefully save time on getting up and running.
Please feel free to update and commit directly to this branch though if you have a personal preference.

@mpdude
Copy link
Member

mpdude commented Apr 13, 2021

@cerupcat I know you're using Swift with private dependenies as well. Could you help us to review this additional information for Swift users?

@rr-james-hickman rr-james-hickman requested a review from mpdude April 13, 2021 16:18
@cerupcat
Copy link

I plan to go through the Readme within the next couple of days and try the steps myself to confirm the same thing works for me.

@rr-james-hickman
Copy link
Contributor Author

rr-james-hickman commented Apr 22, 2021

@cerupcat Any chance you were able to look at this yet?
cc @mpdude

@rr-james-hickman
Copy link
Contributor Author

@mpdude @cerupcat Bump. Would love to get this closed out and off my PR list if you guys have a few minutes to verify 🙏🏼
Thanks!

@rr-james-hickman
Copy link
Contributor Author

@mpdude @cerupcat Bumping again 🙏🏼

@mpdude
Copy link
Member

mpdude commented May 27, 2021

@rr-james-hickman Thank you James for being so persistent on this one!

As I've mentioned above, I felt like the details you gave in the README for Swift were more than necessary. I was afraid of making the README hard to digest, and also afraid of having too much information in it that might get out of date and was not exactly on scope for this action.

I did, however, pick two small additions and just committed them on master, also crediting you.

What do you think – does that do it for you?

Thank you again for your energy put into this!

@mpdude mpdude closed this Jun 2, 2021
@rr-james-hickman
Copy link
Contributor Author

@mpdude No worries, glad to be of service. Hopefully future devs can avoid the headaches I had when trying to get everything to work properly in this type of environment setup.

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.

3 participants