Utility: Copy Files
VSTS | TFS 2018 | TFS 2017 | TFS 2015.3
Copy files from a source folder to a target folder using match patterns.
# Copy Files # Copy files from source folder to target folder using match patterns (The match patterns will only match file paths, not folder paths) - task: CopyFiles@2 inputs: #sourceFolder: # Optional #contents: '**' targetFolder: #cleanTargetFolder: false # Optional #overWrite: false # Optional #flattenFolders: false # Optional
Folder that contains the files you want to copy. If you leave it empty, the copying is done from the root folder of the repo (same as if you had specified
If your build produces artifacts outside of the sources directory, specify
Specify match pattern filters (one on each line) that you want to apply to the list of files to be copied. For example:
The pattern is used to match only file paths, not folder paths. So you should specify patterns such as
More examples are shown below.
|Target Folder||Folder where the files will be copied. In most cases you specify this folder using a variable. For example, specify
|Clean Target Folder||Select this check box to delete all existing files in the target folder before beginning to copy.|
|Over Write||Select this check box to replace existing files in the target folder.|
Copy executables and a readme file
You want to copy just the readme and the files needed to run this C# console app:
`-- ConsoleApplication1 |-- ConsoleApplication1.sln |-- readme.txt `-- ClassLibrary1 |-- ClassLibrary1.csproj `-- ClassLibrary2 |-- ClassLibrary2.csproj `-- ConsoleApplication1 |-- ConsoleApplication1.csproj
On the Variables tab,
$(BuildConfiguration) is set to
Contents (example of multiple match patterns):
ConsoleApplication1\ConsoleApplication1\bin\**\*.exe ConsoleApplication1\ConsoleApplication1\bin\**\*.dll ConsoleApplication1\readme.txt
Contents (example of OR condition):
Contents (example of NOT condition):
ConsoleApplication1\**\bin\**\!(*.pdb|*.config) !ConsoleApplication1\**\ClassLibrary*\** ConsoleApplication1\readme.txt
These files are copied to the staging directory:
`-- ConsoleApplication1 |-- readme.txt `-- ConsoleApplication1 `-- bin `-- Release | -- ClassLibrary1.dll | -- ClassLibrary2.dll | -- ConsoleApplication1.exe
This task is open source on GitHub. Feedback and contributions are welcome.
Q & A
Where can I learn more about file matching patterns?
How do I use this task to publish artifacts?
Q: I'm having problems. How can I troubleshoot them?
A: Try this:
On the variables tab, add
system.debugand set it to
true. Select to allow at queue time.
In the explorer tab, view your completed build and click the build step to view its output.
The control options arguments described above can also be useful when you're trying to isolate a problem.
Q: How do variables work? What variables are available for me to use in the arguments?
$(Agent.BuildDirectory) are just a few of the variables you can use. See Variables.
Do I need an agent?
You need at least one agent to run your build or release. Get an agent.