Visual Studio uses Git to ignore files you don’t want to upload to the remote repository

Foreword

As a .NET developer, with the support of the most powerful IDE in the universe: Visual Studio, our development efficiency has been better improved. We don’t need to worry about the configuration of environment variables and other code management tools, because Visual Studio has many expansion tools. Without further ado, let’s get straight to the point. When we use Visual Studio to develop related .NET projects every day, we often find that nothing has changed in the code we just pulled out. Just running it will generate some files that need to be submitted, such as the most common bin/Debug, bin/Release, obj/Debug, obj/Release files. But I don’t want to submit these files to the remote git code remote repository. In fact, this is very simple. We only need to add an ignore text file (.gitignore) in the project directory when we first create the project, and then push it using git Just go to the remote warehouse.

Submitted files need to be ignored

Configure .gitignore to ignore files and files that do not need to be submitted

Add Visual Studio’s .gitgnore template to the project

Ignore file template (VisualStudio.gitignore) for C#/.NET/.NET Core related projects

As long as the project is developed using Visual Studio, this template can be used.

• VisualStudio.gitignore template GitHub open source address (there are many programming languages or IDE related .gitgnore configurations in this project, which can be downloaded and used directly): https://github.com/github/gitignore/blob/master/VisualStudio.gitignore

## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore

# User-specific files
*.rsuser
*.suo
*.user
*.userosscache
*.sln.docstates

# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs

# Mono auto generated files
mono_crash.*

#Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]release/
[Rr]releases/
x64/
x86/
[Ww][Ii][Nn]32/
[Aa][Rr][Mm]/
[Aa][Rr][Mm]64/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
[Ll]ogs/

# Visual Studio 2015/2017 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/

# Visual Studio 2017 auto generated files
Generated\ Files/

#MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*

#NUnit
*.VisualState.xml
TestResult.xml
nunit-*.xml

# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]releasePS/
dlldata.c

#BenchmarkResults
BenchmarkDotNet.Artifacts/

# .NET Core
project.lock.json
project.fragment.lock.json
artifacts/

#ASP.NET Scaffolding
ScaffoldingReadMe.txt

#StyleCop
StyleCopReport.xml

# Files built by Visual Studio
*_i.c
*_p.c
*_h.h
*.ilk
*.meta
*.obj
*.iobj
*.pch
*.pdb
*.ipdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*_wpftmp.csproj
*.log
*.tlog
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc

# Chutzpah Test files
_Chutzpah*

# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb

# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap

# Visual Studio Trace Files
*.e2e

#TFS 2012 Local Workspace
$tf/

#Guidance Automation Toolkit
*.gpState

# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user

#TeamCity is a build add-in
_TeamCity*

# DotCover is a Code Coverage Tool
*.dotCover

# AxoCover is a Code Coverage Tool
.axoCover/*
!.axoCover/settings.json

# Coverlet is a free, cross platform Code Coverage Tool
coverage*.json
coverage*.xml
coverage*.info

# Visual Studio code coverage results
*.coverage
*.coveragexml

#NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*

#MightyMoose
*.mm.*
AutoTest.Net/

#Web workbench (sass)
.sass-cache/

# Installshield output folder
[Ee]xpress/

# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html

#Click-Once directory
publish/

# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# Note: Comment the next line if you want to checkin your web deploy settings,
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj

# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/

#NuGetPackages
*.nupkg
# NuGet Symbol Packages
*.snupkg
# The packages folder can be ignored because of Package Restore
**/[Pp]ackages/*
# except build/, which is used as an MSBuild target.
!**/[Pp]ackages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/[Pp]ackages/repositories.config
# NuGet v3's project.json files produces more ignorable files
*.nuget.props
*.nuget.targets

# Microsoft Azure Build Output
csx/
*.build.csdef

# Microsoft Azure Emulator
ecf/
rcf/

# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
*.appx
*.appxbundle
*.appxupload

# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!?*.[Cc]ache/

# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs

# Including strong name files can present a security risk
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
#*.snk

# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/

#RIA/Silverlight projects
Generated_Code/

# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
ServiceFabricBackup/
*.rptproj.bak

# SQL Server files
*.mdf
*.ldf
*.ndf

#BusinessIntelligenceprojects
*.rdl.data
*.bim.layout
*.bim_*.settings
*.rptproj.rsuser
*-[Bb]ackup.rdl
*- [Bb]ackup ([0-9]).rdl
*- [Bb]ackup ([0-9][0-9]).rdl

#MicrosoftFakes
FakesAssemblies/

#GhostDoc plugin setting file
*.GhostDoc.xml

# Node.js Tools for Visual Studio
.ntvs_analysis.dat
node_modules/

# Visual Studio 6 build log
*.plg

# Visual Studio 6 workspace options file
*.opt

# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
*.vbw

# Visual Studio 6 auto-generated project file (contains which files were open etc.)
*.vbp

# Visual Studio 6 workspace and project file (working project files containing files to include in project)
*.dsw
*.dsp

# Visual Studio 6 technical files
*.ncb
*.aps

# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions

# Paket dependency manager
.paket/paket.exe
paket-files/

#FAKE - F# Make
.fake/

#CodeRush personal settings
.cr/personal

# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc

#Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config

#TabsStudio
*.tss

# Telerik's JustMock configuration file
*.jmconfig

# BizTalk build output
*.btp.cs
*.btm.cs
*.odx.cs
*.xsd.cs

# OpenCover UI analysis results
OpenCover/

# Azure Stream Analytics local run output
ASALocalRun/

# MSBuild Binary and Structured Log
*.binlog

# NVidia Nsight GPU debugger configuration file
*.nvuser

# MFractors (Xamarin productivity tool) working folder
.mfractor/

# Local History for Visual Studio
.localhistory/

# Visual Studio History (VSHistory) files
.vshistory/

# BeatPulse healthcheck temp database
healthchecksdb

# Backup folder for Package Reference Convert tool in Visual Studio 2017
MigrationBackup/

# Ionide (cross platform F# VS Code tools) working folder
.ionide/

# Fody - auto-generated XML schema
FodyWeavers.xsd

# VS Code files for those working on multiple tools
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace

# Local History for Visual Studio Code
.history/

# Windows Installer files from build outputs
*.cab
*.msi
*.msix
*.msm
*.msp

#JetBrainsRider
*.sln.iml

.gitignore ignore rules

Basic syntax:

• Comments starting with “#” sign;

• Starting with a slash “/” indicates a directory;

• Use asterisk “*” to wildcard multiple characters;

• Use question mark “?” to wildcard a single character;

• A match list containing a single character enclosed in square brackets “[]”;

• An exclamation point “!” indicates that the matched files or directories are not ignored (tracked);

• In addition, git matches the rules from top to bottom for .ignore configuration files line by line, which means that if the previous rules match a larger range, the later rules will not take effect;

Code example

# This is a comment – will be ignored by Git
  
*.a # Ignore all files ending in .a
!lib.a # except lib.a
/TODO # Only ignore TODO files in the project root directory, excluding subdir/TODO
build/ # Ignore all files in the build/ directory
doc/*.txt # will ignore doc/notes.txt but not doc/server/arch.txt

Process files submitted to the remote warehouse

You may have forgotten to add the ignore file configuration (gitignore) during development and push these files to the remote warehouse. We have the following two methods to solve the problem:

• 1. Delete these local files and submit them to the remote end (provided that these files are environment variable files, it is not recommended if they cannot be automatically generated).

• 2. Use the following git command:

//When we need to delete a file in the staging area or branch, but we need to use it locally, but we just don’t want this file to be version controlled, we can use it
git rm -r --cached file_path (file path) //Delete the file_path file in the staging area of the current branch
git add . //Submit the current operation to the local temporary storage area
git commit -m 'delete remote somefile' //Submit to local git repository
git push //Submit to the remote code base

For example, I need to remove the obj file in a project and then submit:

The file path is: D:\Development Learning-Master\My Training Camp\DailyLearning\Work & Learning.Net Training Camp\Application\obj

Enter the following command to remove related files that do not need to be tracked:

git rm -r --cached Application/obj

After successful execution, the file will be deleted from the branch (it will still exist locally), and finally we can submit it to the remote warehouse.

The knowledge points of the article match the official knowledge files, and you can further learn related knowledge. Git skill treeHomepageOverview 6780 people are learning the system