X Tutup
The Wayback Machine - https://web.archive.org/web/20210210085805/https://github.com/github/gitignore/pull/3083
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

Swift: ignore .swiftpm #3083

Merged
merged 2 commits into from Aug 7, 2019
Merged

Swift: ignore .swiftpm #3083

merged 2 commits into from Aug 7, 2019

Conversation

@maxxfrazer
Copy link
Contributor

@maxxfrazer maxxfrazer commented Jun 7, 2019

Reasons for making this change:

SPM now supported with Xcode 11; .swiftpm is generated by Xcode and is not needed on git

Links to documentation supporting these rule changes:

Basing off Apple's swift-package-manager .gitignore
https://github.com/apple/swift-package-manager/blob/master/.gitignore

@@ -38,7 +38,9 @@ playground.xcworkspace
# Packages/
# Package.pins
# Package.resolved
# *.xcodeproj

This comment has been minimized.

@Coeur

Coeur Jul 23, 2019
Contributor

Really no need to give the wrong idea here: xcodeproj files are very needed in almost all the iOS/macOS projects of the world. So I wouldn't add this commented line.

This comment has been minimized.

@maxxfrazer

maxxfrazer Jul 23, 2019
Author Contributor

This is specifically for swift packages; you open the Package.swift file with Xcode and all your code is brought in through that. The xcodeproj file can generated using swift package generate-xcodeproj.

If you're still not convinced though I'll remove the line.

This comment has been minimized.

@Coeur

Coeur Jul 23, 2019
Contributor

Currently, I'm not used enough to Xcode 11 beta SPM to answer if there are better alternatives. I've ping previous committers.

@Coeur
Copy link
Contributor

@Coeur Coeur commented Jul 23, 2019

@FabrizioBrancati @natestedman Can you review to tell if .swiftpm is needed or not?

@FabrizioBrancati
Copy link
Contributor

@FabrizioBrancati FabrizioBrancati commented Jul 26, 2019

I found some interesting links:

It seems that adding this file to .gitignore is up to the developer or based on the project, but even the Swift Package Manager Apple team said to do not add this folder to .gititnore, because it helps the team to use the same dependencies, etc.

Maybe if it's commented by default, we can keep it.

@maxxfrazer
Copy link
Contributor Author

@maxxfrazer maxxfrazer commented Jul 26, 2019

Ok, seems like something a lot of developers might want to ignore, especially if they're creating a package without dependencies - as Ankit has added it to the SPM Package.
But would be best to just have it as a commented line, allowing people to turn it on easily.

I'll move this up a line to group it with the other commented suggestions & comment it out. Do you think leaving a comment message would be necessary or just leave it there?

Based on the InitPackage.swift file I think it would be appropriate to leave *.xcodeproj as a commented addition to the file also RE @Coeur's concerns.

@FabrizioBrancati
Copy link
Contributor

@FabrizioBrancati FabrizioBrancati commented Aug 4, 2019

Yes, leave a comment to explain when and why the developer has to uncomment that line.
Also, I think that leaving the *.xcodeproj line is ok, the developers that don't want to commit it will uncomment that line.

@maxxfrazer
Copy link
Contributor Author

@maxxfrazer maxxfrazer commented Aug 5, 2019

@FabrizioBrancati should be all set if the added comment is to satisfaction 🚀

@Coeur
Coeur approved these changes Aug 6, 2019
@shiftkey
Copy link
Member

@shiftkey shiftkey commented Aug 7, 2019

@maxxfrazer thanks for the contribution, and thanks @Coeur @FabrizioBrancati for the reviews!

@shiftkey shiftkey merged commit a3e8e14 into github:master Aug 7, 2019
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@Coeur
Copy link
Contributor

@Coeur Coeur commented Aug 7, 2019

@shiftkey I wouldn't mind a merge on another PR that only changes the comments: #3133

@shiftkey
Copy link
Member

@shiftkey shiftkey commented Aug 7, 2019

@Coeur no problem - just catching up on notifications during a quiet morning, so I'll prioritize that next

SaifurRahmanMohsin added a commit to SaifurRahmanMohsin/gitignore that referenced this pull request Aug 29, 2019
* upstream/master:
  Added Simulink cache files (github#3148)
  Add esp-idf.gitignore (github#3150)
  Add *.sch-bak to KiCad.gitignore (github#3153)
  Reference why to exclude binary jar, fixes github#111 (github#3154)
  Update Autotools.gitignore (github#3005)
  Improving the documentation of Objective-C and Swift files (github#3133)
  Ignore gummi previews (github#3144)
  Swift: ignore .swiftpm (github#3083)
  Update Godot.gitignore (github#3142)
  Revert of github#2988. TextMesh Pro files are not auto managed (github#3134)
  Partial revert of 837181e (github#3132)
  Added more glossaries auxiliary files and makeindex logs to TeX template (github#3104)
  .travis.yml: Trim trailing whitespace and indent (github#3118)
  Add *.hie to Haskell.gitignore (github#3120)
  Ignore the .ionide working folder (github#3108)
r2pgl added a commit to r2pgl/gitignore that referenced this pull request Mar 15, 2020
* added files to be ignored with swift package manager

* added comment for swiftpm and why it might want to be included in .gitignore
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
X Tutup