TeamCity
 
6.5
You are viewing the documentation for an earlier version of TeamCity.
  1. TeamCity Documentation
  2. TeamCityReference
  3. Administrator's Guide
  4. Managing Projects and Build Configurations
  5. Creating and Editing Build Configurations
  6. Configuring Build Steps
  7. Adding Build Features
  8. Build Files Cleaner (Swabra)

Build Files Cleaner (Swabra)

Last modified: 20 April 2023

Bundled Swabra plugin allows to clean files created during the build. The files modified or deleted during the build are also reported in the build log (however they are not affected by the plugin). The plugin remembers the state of the file tree after the sources checkout and on next build start deletes all the newly added files. Swabra can also ensure clean checkout for directory and clean checkout at build start if there are any modified or deleted files in the checkout directory. Moreover, Swabra also gives the ability to dump processes which locked the checkout directory before build finish (requires DownloadingHandle)

Swabra can be added as a build feature to your build configuration regardless of what set of build steps you have. By configuring its options you can enable scanning checkout directory for newly created, modified and deleted files and enable file locking processes detection.

Checkout directory state is saved into a file in the caches directory named <checkout_directory_name_hash>.snapshot using DiskDir format. Checkout directory to snapshot name map is saved into snapshot.map file. The snapshot is used later (at the start of the next build) to determine which files and folders are newly created, modified or deleted. It is done by actual files' presence, last modification data and size comparison with corresponding records in the snapshot.

Configuring Swabra Options



Option

Description

Files cleanup

Select whether you want to perform build files cleanup, and when it should be performed.

Clean checkout

Select the Force clean checkout if cannot restore clean directory state option to ensure that the checkout directory corresponds to the sources in the repository at the build start. If Swabra detects any modified or deleted files in the checkout directory before the build start, it will enforce clean checkout. The build will fail if Swabra cannot delete some files created during previous build. If this option is disabled you will only get warnings about modified and deleted files.

Paths to monitor

Specify newline or comma separated set of +|-:checkout_dir_relative_path rules to define what files and folders should be involved in files collection process (by default all paths are included). If no +: or -: prefix is specified, a rule as treated as "include". A path can be checkout directory relative path or a mask with ant-style wildcards. Ignoring a directory leads to ignoring the whole it's content. Rules on any path should come in order from more abstract to more concrete, e.g. use -:* /dir/ * to exclude all dir folders and their content, or -:some/dir, +:some/dir/inner to exclude some/dir folder and all it's content except inner subfolder and it's content.

note

Note that after removing some exclude rules it's advisable to run clean checkout.

Locking processes

Select whether you want Swabra to inspect the checkout directory for processes locking files in this directory, and what to do with such processes. Note that for locking processes detection DownloadingHandle is required on agents.

Verbose output

Check this option to enable detailed logging to build log.

Default excluded paths



If the build is set up to checkout on agent swabra by default ignores all .svn, .git, .hg, CVS folders and their content. To turn off this behaviour specify empty swabra.default.rules configuration parameter.

Downloading Handle



You can download handle.exe from the Administration | Server Configuration | Tools tab. Select Sysinternals handle.exe from the list of tools, specify URL for downloading handle.exe or download it manually and specify path on local machine, click Continue and TeamCity will automatically download or upload handle.exe and send to Windows agents.

handle.exe is present on agents only after the upgrade process.

You may also download handle.exe, extract it on agent and set up the handle.exe.path system property manually.

Please note that running handle.exe requires some additional permissions for the build agent user. For more details please read this thread.

Debug options



Generally snapshot file is deleted after files collection. Set swabra.preserve.snapshot system property to preserve snapshots for debug purposes.

Development links



Sources in JetBrains Subversion repository. Builds for TeamCity 5.x and Builds for TeamCity 5.0.x and Builds for TeamCity 4.5.x at JetBrains public TeamCity