Child pages
  • Swabra

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: notes about swabra UI changes in 6.0

...

Plugin was bundled with TeamCity 5.1.
In TeamCity 6.0 Swabra became a build feature.

Documentation

Installation instructions

...

The plugin can be used with any runnerrunners. Swabra tab provides UI options to enable scanning checkout directory for newly created, modified and deleted files and for enabling file locking processes detection.

...

Сonfiguring plugin via UI options

For TeamCity 6.0

The plugin can be configured as a build feature from Build Steps page.

Choose suitable Files cleanup mode which can be After build finish or Before next build start.

Use Clean checkout to ensure that the checkout directory corresponds to the sources in the repository at the build start. If detecting any modified or deleted files in the checkout directory before the build start Swabra will enforce clean checkout. The build will also fail if some newly created during previous build files can't be deleted.

Use Paths to monitor setting to specify newline or comma delimited set of +|-:checkout_dir_relative_path rules.

Select Locking processes mode to inspect the checkout directory for processes locking files in this directory.
Choose Report or Kill mode to get report about such processes in the build log or kill them.
Note that for locking processes detection handle.exe is required on agents. Click the Insatall SysInternals handle.exe link for downloading or uploading.

Check Verbose output option to enable detailed logging to build log.

For TeamCity 5.1.x

The plugin adds its configuration settings panel to the runner settings page.

Check Perform build files cleanup option to enable build files cleanup.

Use Ensure clean checkout directory to ensure that the checkout directory corresponds to the sources in the repository at the build start. If detecting any modified or deleted files in the checkout directory before the build start Swabra will enforce clean checkout. The build will also fail if some newly created during previous build files can't be deleted.

...

Use Cleanup rules setting to specify newline or comma delimited set of +|-:checkout_dir_relative_path rules.

Select Locking processes mode to inspect the checkout directory for processes locking files in this directory.
Choose Report or Kill mode to get report about such processes in the build log or kill them.
Note that for locking processes detection handle.exe is required on agents. Click the Insatall SysInternals handle.exe link for downloading or uploading.

Check Verbose output option to enable detailed logging to build log.

Paths to monitor

How to use

These rules tell Swabra what files and folders should be involved in files collection process.
If no +: or -: prefix is specified rule as treated as include.
A path can be checkout directory relative path or a mask with ant-style wild cards.

...

Note

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

Use Locking processes setting to inspect the checkout directory for processes locking files in this directory.
Choose Report or Kill options to get report about such processes in the build log or kill them.
Note that for locking processes detection handle.exe is required on agents. Click the Insatall SysInternals handle.exe link for downloading or uploading.

Check Verbose output 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.ignored.paths system.property.

...