Skip to content

Update .gitignore #220

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

Merged
merged 1 commit into from
Dec 13, 2022
Merged

Update .gitignore #220

merged 1 commit into from
Dec 13, 2022

Conversation

mhdostal
Copy link
Member

Updates .gitignore so we don't get the Package.resolved file + other SPM files.

Copy link
Collaborator

@dfeinzimer dfeinzimer left a comment

Choose a reason for hiding this comment

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

If you use Swift package dependencies in your project, make sure to include the Package.resolved file in your Git repository and commit any changes to it. Don’t include the file in your .gitignore file. via Apple Documentation

This is probably in the context of app level projects but we technically depend on the Swift SDK, right? Thoughts?

@mhdostal
Copy link
Member Author

Yes, we depend on the SDK Sounds like we should commit it, instead of changing the .gitignore file. @yo1995 ?

@yo1995
Copy link
Contributor

yo1995 commented Dec 13, 2022

Please refer to Esri/arcgis-runtime-samples-ios#1062 for more details, where I first added these exclusions to gitignore for samples. The thinking was:

  • when we merge samples v.next to main, no changes will happen to main until the next SDK release (except breaking hotfixes)
  • that means if the SDK or toolkit bumps minor version, the samples on main still builds without any changes
  • if we include the package lock files, then the version and SHA are frozen. User needs to explicitly run Packages > Reset Package Caches in order to build with the latest dependencies, which is not what we want
  • besides, the doc shared by David looks like to be CI/CD specific, if not Xcode Cloud only. I don't think that applies to samples

Whether not including package resolved for toolkit is up to your decision. Since toolkit is a Swift package rather than an app, I can see the arguments from both sides. 👀

@mhdostal
Copy link
Member Author

Whether not including package resolved for toolkit is up to your decision. Since toolkit is a Swift package rather than an app, I can see the arguments from both sides.

Thanks @yo1995.

The original Toolkit included Package.resolved in the .gitignore, so I'm fine putting it in the file here.

@mhdostal mhdostal requested a review from dfeinzimer December 13, 2022 20:35
@mhdostal mhdostal merged commit 75ce218 into main Dec 13, 2022
@mhdostal mhdostal deleted the mhd/gitignore branch December 13, 2022 22:31
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