Build Server Integration
A build server integration helps you reduce the amount of duplicated effort that is performed by your development teams. An integration between YouTrack and a build server enables useful features in both applications:
YouTrack pulls build numbers from connected projects. You can add these build numbers to the set of values for a custom field in one or more integrated projects.
The integration settings let you automatically assign build numbers to issues that are referenced in assembled builds. When the build number is assigned to an issue automatically, YouTrack adds an icon next to each build number that is stored in the custom field. Users can click this icon to open the build that includes the reference to the issue.
You can also use a query to assign build numbers to issues that match a predefined search criteria.
Your developers can reference issue IDs in build comments or commit messages. When the VCS integration settings are enabled, the build server integration adds a direct link to the YouTrack issue in the change details.
The comment or commit message is automatically added to the list of changes in the activity stream for the issue in YouTrack. Each VCS change includes a direct link to the change details in the build server.
Your developers can also specify commands in their commit messages. When the build server assembles a build that contains the commit message, the command is applied all of the issues that are referenced in the commit message. Developers can use this feature to update or add comments to one or more issues without even opening YouTrack.
Build Server Integration Settings
You can access the Build Server Integration Settings page from the Integrations section of the Administration menu.
This page displays a list of build servers that are integrated with YouTrack. The table shows the name of each integrated project, a link to the connected build, and the number of the last processed build.
The following controls are available on this page:
Control | Description |
|---|---|
Pull fresh data | Sets the interval for pulling fresh data from all connected build servers. For more information, see Set the Schedule for Pulling Data from Build Servers. |
New mapping | Opens the Create Mapping dialog in the sidebar. Use these settings to map a YouTrack project to a build configuration. |
Run | Pulls fresh data from the build server for the selected project. Links to builds are added to issues in YouTrack based on the current integration settings. Commands in VCS commit messages are applied to the corresponding issues. Build numbers are added to issues according to the options that are defined in the mapping. The last processed build is updated in the corresponding column on the integration settings page. |
Edit | Opens the settings for the selected build server or mapping in the sidebar. |
Remove | Removes the selected build server integration or mapping from YouTrack. |
Reset | Removes the IDs of the last recorded change and processed build from the selected project mapping. The next time the integration is scheduled to update, YouTrack pulls the entire change and build history from the build server. Changes and builds that already exist in YouTrack are not affected. |
Disable | Disables the integration in the selected build server or project. Use this option at the project level to disable integration features on a per-project basis. If the integration is disabled, the Enable option is available. |
New build server integration | Opens a dialog in the sidebar that lets you define a connection with a new build server. |
Set the Schedule for Pulling Data from Build Servers
YouTrack pulls data from connected build servers according to a schedule. The default interval is 10 minutes. You can change the schedule to a predefined interval or specify a custom interval with a cron expression. You cannot set the schedule independently for multiple build servers. The same schedule is applied to all build servers that are integrated with YouTrack.
To specify an interval for pulling data:
In the Integrations section of the Administration menu, select Build Server Integration.
From the Pull fresh data drop-down menu, select a pre-configured time interval. To specify another time interval, select Custom and enter a cron expression. For example, to pull fresh data every 45 minutes, every day, use the following expression:
0 0/45 * * * ?To learn more about cron expressions, refer to the cron trigger tutorial.