The Schedule Trigger allows you to set the time when a build of the configuration will be run. The Builds Schedule page of the current project settings displays the configured build times. More than one Schedule trigger can be added to a build configuration.
On this page:
- Triggering Conditions
- Additional Options
The settings in this section define time and other conditions for automatic build triggering. You can schedule a recurring build or set a specific date and time for it.
Date and Time
In addition to triggering builds daily or weekly at a specified time for a particular time zone, you can specify advanced time settings using cron-like expressions. This format provides more flexible scheduling options.
Each 2 hours at :30
Every day at 11:45PM
Every Sunday at 1:00AM
Every last day of month at 10:00AM and 10:00PM
See also other examples.
Brief description of the cron format used
Cron expressions are comprised of six fields and one optional field separated with a white space. The fields are respectively described as follows:
, - * /
, - * /
, - * /
, - * ? / L W
1-12 of JAN-DEC
, - * /
1-7 or SUN-SAT
, - * ? / L #
, - * /
For the description of the special characters, please refer to Quartz CronTrigger Tutorial.
You can restrict schedule trigger to start builds only if there are pending changes in your version control by selecting the corresponding option. The Trigger only if there are pending changes option considers newly detected pending changes only: if there were pending changes before the trigger was created, the build is not triggered.
VCS Trigger Rules
If no trigger rules specified, a build is triggered upon any detected change displayed for the build configuration. You can affect the changes detected by changing the VCS root settings and specifying Checkout Rules.
To limit the changes that trigger the build, use the VCS trigger rules. You can add these rules manually in the text area (one per line), or use the Add new rule option to generate them.
Each rule is ether an "include" (starts with "+") or an "exclude" (starts with "-").
The general syntax for a single rule is:
- Ant_like_wildcard - A wildcard to match the changed file path. Only "*" and "**" patterns are supported,the "?" pattern is not supported. The file paths in the rule can be relative (not started with '/' or '\') to match resulting paths on the agent or absolute (started with '/') to match VCS paths relative to a VCS root. For each file in a change the most specific rule is found (the rule matching the longest file path). The build is triggered if there is at least one file with a matching "include" rule or a file with no matching "exclude" rules.
- VCS_username- if specified, limits the rule only to the changes made by a user with the corresponding VCS username .
- VCS_root_id - if specified, limits the rule only to the changes from the corresponding VCS root.
- VCS_comment_regexp - if specified, limits the rule only to the changes that contain specified text in the VCS comment. Use the Java Regular Expression pattern for matching the text in a comment (see examples below). The rule matches if the comment text contains a matched text portion; to match the entire text, include the ^ and $ special characters.
Trigger Rules Examples
The Schedule Trigger can watch a build in a different build configuration and trigger a build if the watched build changes.
In the Build Changes section, select the corresponding box and specify the build configuration and the type of build to watch: last successful build, last pinned build, last finished build, or the last finished build with a specified tag.
TeamCity can promote the watched build if there is a dependency (snapshot or artifact) on its build configuration.
Enforce Clean Checkout
It is possible to force TeamCity to clean all files in the checkout directory before a build. This option can also be applied to snapshot dependencies. In this case, all the builds of the build chain will be forced to use clean checkout. The option also enables rebuilding all dependencies (unless custom dependencies are provided via the custom build dialog or the schedule trigger promotes a build).
Trigger Build on All Enabled and Compatible Agents
Use this option to run a build simultaneously on all agents that are enabled and compatible with the build configuration. This option may be useful in the following cases:
Build Queue Optimization Settings
By default, TeamCity optimizes the build queue: already queued build can be replaced with an already started build or a more recent queued build. To disable the default behavior, uncheck the box.
When a VCS Root has branches configured, the Branch filter setting appears in the trigger options.
The Branch filter setting limits a set of logical branch names (the branch names as they appear in the TeamCity UI) which trigger should apply to. The branch filter uses format and precedence similar to the branch specification (but it matches logical branch name and uses no parenthesis).
Details of the format:
logical branch name is the part of the branch name matched by the branch specification (i.e. displayed for a build in TeamCity UI), see Working With Feature Branches.
It is possible to use the wildcard placeholder ('*') which matches one or more characters:
+|-:name* will match the branch '
name1' but will not match the branch '
name', which will need to be added explicitly.
Only the default branch is accepted:
All branches except the default one are accepted:
Only branches with the
feature- prefix are accepted:
By default, the branch filter is set to
+:*, which is the equivalent of an empty branch filter. In this case that a build will be triggered on every branch tracked by the branch specification.
If several rules match a single branch, the most specific (least characters matched by pattern) last rule apply.
The branch filter in the Schedule Trigger works as follows:
- if the option trigger build only if there are pending changes is turned ON, then the trigger will add a build to the queue for all branches matched by the trigger branch filter where pending changes exist
- if trigger build only if there are pending changes is turned OFF, then the trigger will add a build to the queue for all branches matched by the trigger branch filter regardless of presence of pending changes there
Trigger Rules and Branch Filter Combined
Trigger rules and branch filter are combined by AND, which means that the build is triggered only when both conditions are satisfied.
For example, if you specify a comment text in the trigger rules field and provide the branch specification, the build will be triggered only if a commit has the special text and is also in a branch matched by branch filter.