ChatGPT解决这个技术问题 Extra ChatGPT

Get TFS to ignore my packages folder

I'm trying to get TFS (2013) to ignore my packages folder. I passionately don't want it source controlled as I'm using NuGet and it's great!

I've tried cloaking (doesn't seem to work), I've tried adding .tfignore files - nothing is ignored. Why don't the TFS team just add an option to permanently ignore a folder or file like lots of the Subversion clients do?!

What versions of TFS and Visual studio are you using? Are you using local or server workspaces?
You should change the answer on this question
If you're using NuGet the packages folder is required. You can set NuGet to restore the missing binaries on build though (so that you source control the packages folder, but ignore the binaries). -- But there's problems with that: It's possible for a NuGet binary to get updated (without the version number changing), or to get removed, etc. -- It's possible for all sorts of weird oddities to happen. Don't leave your builds to chance -- check in the whole packages folder. You'll save yourself a lot of headaches.

P
Pharylon

Here's the deal: We have to tell both NuGet and TFS to ignore the packages, because NuGet is trying to do source-control related stuff that it absolutely shouldn't be doing (bad form, Microsoft!). So you have to do two things.

First, add a file named .tfignore to the solution folder (note the lack of s after the tf). Its contents should be as follows:

\packages

That tells TFS to ignore your packages folder. Now, you would think that this would also ignore the repositories.config file. But it won't. Why? Who knows, the ways of Microsoft are strange and mysterious. Actually, I think it's part of the NuGet stuff I outline below, but if that ever gets fixed in the future and you want to keep the repositories.config file instead of letting VS regenerate it, you should be able to use this:

\packages
!\packages\repositories.config

OK, so now thanks to our .tfignore file, TFS is ignoring your packages. Everything is fine, right? WRONG, because NuGet is mucking around with your source control and adding the packages to your pending changes. So now let's tell NuGet to cut it out already.

Create a folder called .nuget in the root of your solution folder.1 Now, create a file called NuGet.config, and put it in this new folder2. Its contents should look like this:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <solution>
    <add key="disableSourceControlIntegration" value="true" />
  </solution>
</configuration>

And now your packages should stay out of source control. Just remember to add the NuGet.config and .tfignore files to source control so they never get lost.

EDIT: If you're having issues, you may want to delete your packages folder, check in that change, and then go through the steps above.

ALSO EDIT: It looks like this won't happen with newer versions of Nuget. So maybe if you switch to VS/TFS 2017 this issue will clear up without jumping through the above hoops.

1. Add the folder using Source Control Explorer; right-click the solution->Add folder->.nuget 2. When I figured this out using VS 2013, I found the NuGet.config had to go in the .nuget folder. Even if you already have a NuGet.config file in the root of your solution folder (because, say, your company has an internal nuget feed). However, some in the comments have indicated that it works fine in the solution root in VS 2015. Personally, I switched to using TFS in git mode, so I can't test. Additionally, if you do have a custom feed, ensure that you have both the custom feed and nuget.org as keys in the Nuget.config file, or sometimes TFS will randomly decide it can't restore the packages.


I believe this requires TFS 2012 at least. stackoverflow.com/questions/14365929/…
@zespri What file is pending a delete? The NuGet package? That shouldn't be pending a delete... it should be deleted! After you do what I suggested above, go to Team Explorer and delete all of the Nuget packages that might already be in source control. Or just delete the packages folder altogether. I've been rolling with this setup for months and never experienced that error.
Fyi in VS2015, nuget.config does not have to be inside /.nuget/. It works great in the solution root.
For anyone wondering how to create a folder and file that starts with a period, end the name with another period. So that would be .tfignore. and .nuget.
@DerekZiemba Neat trick! I've been doing it through the command line all these years. I think it's worth mentioning that when you do that, the trailing '.' will be removed, I initially thought your suggestion was to just live with an extra '.' on the end.
R
Ryan Gates

An alternative solution to the above is the following.

Add the packages folder to TFS (without any files or sub-folders)

Right Click the Packages Folder

Left Click Advanced

Click Cloak

It is worth noting that this solution would need to be applied per TFS workspace. It has worked far more reliably for me rather than using the .tfignore file.

You can read more about this approach in the blog article Prevent TFS from adding installed NuGet packages to source control.


A
Adam Stewart

for people reporting that the .tfignore option wasn't working with the nuget.config setting it might be of interest - these steps finally worked for me:

Delete everything in my packages folder Make sure TFS doesn't have any changes around that folder pending Close VS Re-open VS, and reload solution - using Nuget restore to re-populate packages Note no changes are pending for TFS source control


This worked for me after applying Pharylon's solution, which I did after restoring packages.
Really Helpful, We must do this for Initial Time(First Commit of the .tfignore file to the TFS), But Not Every one. if i'm correct.
I think this approach will work only on the machine that make the cloak. I'm I right? so this doesn't solve the root problem to all team members.
A variation of this worked for me - I ensured that nothing from Packages had been committed already, then deleted the packages directory from disk. At this point, it was still showing as a pending changes in the VS team explorer, so I chose to Undo the changes that were pending in the packages directory. This cleaned it up (without me needing to close/reopen), and they're not coming back =)
T
Terje Sandstrøm

Add a nuget.config file in a .nuget folder in your solution. Add the following to the nuget.config file:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <solution>
    <add key="disableSourceControlIntegration" value="true" />
  </solution>
</configuration>

The disableSourceControlIntegration is what makes the trick for TFS Version Control.


Has no effect - also not a global solution at all.
@So Many Goblins: Have you tried this on a completely new project/sln ? (Just for checking it out) I'm curious what in your setup makes this not work, as it works every time I do it myself, and it is the recommended way of doing this with TFS/nuget. Also, which version of VS/TFS do you see this on?
Visual studio 2013. New solution, aye. I worked around this issue adding a .tfignore ignoring explicitly each package.
Okay, this is effectively what "Enable NuGet Package Restore" does. Just be sure to CLOSE and re-open your solution! The NuGet.config file only gets read upon opening your solution.
This didn't work for me quite on visual studio online and VS2013. I used Right Click Solution > Enable NuGet Package Restore. This will add the Nuget.config file to solution root Add the .tfignore. I normally do this by adding a text file to the solution root, letting it detect that and then exclude by clicking 'detected add' > right click ignore. Then check everything in, including any packages Then delete all the packages in your solution and check in this change (this will remove the packages from TFS) Open the solution and build which will add the packages but TFS will not pick them up.
D
Daniel Mann

You need to be using local workspaces for .tfignore to work. The .tfignore file must be in the folder that contains the files or folders you want to ignore.

So if your solution structure looks like this:

\Project
   \Packages
   \OtherStuff
   foo.cs

You'd put your .tfignore file in \Project:

\Project
   \Packages
   \OtherStuff
   foo.cs
   .tfignore

The contents of the .tfignore in your case would be:

\packages

Here's some documentation for you: http://msdn.microsoft.com/library/vstudio/ms245454(v=vs.110).aspx#tfignore


I've added the .tfignore files and when I build the project it's still trying to add packages to tfs. There seems little I can do to stop it.
Can you post the ignore file you added?
See docs.nuget.org/docs/reference/package-restore-with-team-build - it's a NuGet bug with .tfignore, but can be corrected by telling NuGet to go shove itself for SCM integration.
It looks like you're example might be wrong, It think it should be packages instead of \packages as it's relative.
R
Riegardt Steyn

You can permanently set this once-off in your AppData\Roaming for all solutions (old & new)!

In your %AppData%\NuGet\NuGet.Config file, add the following just before the </configuration> XML tag...

<config>
  <add key="repositoryPath" value="C:\NuGetPackages" />
</config>
<solution>
  <add key="disableSourceControlIntegration" value="true" />
</solution>

...you can specify any path you want - the important thing is putting it OUTSIDE your TFS workspace!

Now you never have to worry about that stuff again. Your solution folder will not contain any packages anymore; all solutions will default to using your custom packages location instead.

NOTE - This works is on a per-user basis.


Sounds good and possibly much simpler. You do have to enforce this setup across your team, and especially your build servers' login/setup as well if you take this approach?
I would imagine so. I have not tested this WRT build servers, sorry. I would also imagine that different folder paths to the lib folders could cause problems (I think some NuGet packages have hard-references to the lib paths if I recall correctly).
J
Just TFS

Set your solution to restore on build, the package folder and packages file will be checked in but the packages won't.


Please explain "restore on build".
The Visual Studio right-click "enable NuGet package restore" functionality is deprecated as of NuGet 2.7 -- TFS 2013 natively supports restoring NuGet packages without the NuGet.targets file and modifications to the proj files.
M
MrHinsh - Martin Hinshelwood

If you are using Git with TFS you need to add a ".gitignore" file. You can do this in "team project | Settings | 'add ignore file'". Then open the file and uncomment the built in ignore statement for Nuget Packages.

If you are using TFVC and you have Local Workspaces configured you can use the ".tfignore" file that honours an identical format to the Git file. I think you need "packages/".


we us TFSVC and as already mentioned in the initial post - the .tfignore file is not workting.
As I stated you need to use the correct format of .tfignore. I believe you have the slash the wrong way round
@MrHinsh after speaking with Ed Thompson, the .tfignore file doesn't work correctly. The .gitignore does though.
@Ed needs to go fix that ;)
D
David Wilton

This didn't work for me quite on visual studio online and VS2013.

Right Click Solution > Enable NuGet Package Restore. This will add the Nuget.config file to solution

https://i.stack.imgur.com/LKpuk.png

Add the .tfignore. I normally do this by adding a text file to the solution root, letting it detect that and then exclude by clicking 'detected add' > right click ignore.

https://i.stack.imgur.com/kW00I.png

Add the packages to .tfignore and tell it to include repositories.config

https://i.stack.imgur.com/ZaWd4.png

From the other comments it seems your milage may vary at this point. This is what I do:

Check everything in, including any packages.

Delete all packages in your solution and then check in this change (this will remove the packages from TFS)

Open the solution and build which will add the packages to the project but TFS will not pick them up.


First, Enable Nuget restore is depreceated, and not there in VS 2015, if you go that route later. Second: Checking packages and dlls in will add them to the source control, deleting them in the solution and checking that in will NOT remove them from SC, just from the tip of your branch. –
@TerjeSandstrøm point taken, but the question is specific to 2013. Yes you are right, you would have to use tf destroy to remove it permanently from source control, but I found no other way to get TFS to adhere to the .tfignore file
r
redcalx

The solution that worked for me was to create both a .tfignore and the following setting in the Nuget.Config:

<configuration>
  ...
  <solution>
    <add key="disableSourceControlIntegration" value="true" />
  </solution>  
  ...
</configuration>

My .tfignore contains this line:

\packages

[I'm using Visual Studio 2015 Update 2]

This is not ideal, and is currently logged as an open issue on github/nuget:

Make it easier to omit packages from TFVC #493


C
Community

Terje's answer doesn't work all the time for me, sometimes it will work for a while, but then it will pend a load of "adds" for me all over again.

The only way I have found to solve this permanently is to Cloak the packages folder in my Workspace.

For example:

Type      Server                Local
============================================
Active    $/Work/Main           C:\Code\Main
Cloaked   $/Work/Main/Packages

That was very weird. Do this happens with the latest Visual Studio and NuGet versions ?
Yes, I run VS 2013.4 and NuGet 2.8 on TFS 2012 local workspaces.
You have to cloak EVERY package folder for dozends of projects and polutions. Also every member of the Team has to repeat the procedure for every workspace
Cloak is not a good answers and the two other answers above work and are by design. There must be something else going on in your environment.
@MrHinsh - various people in the dept have looked at this and it is just broken. It seems OK with Git, but when using TFVC it does this all the time.
c
coding4fun

I had the same issue. /packages should work but didn't for me. packages*.* did work.


关注公众号,不定期副业成功案例分享
Follow WeChat

Success story sharing

Want to stay one step ahead of the latest teleworks?

Subscribe Now