TeamCity
 
3.0
You are viewing the documentation for an earlier version of TeamCity.

EnableStatusWidget

Last modified: 20 April 2023

Enabling the Status Widget for Build Configurations



Check this option to enable retrieving the status of the latest build of one or several build configurations by any web page, so the build's status can be displayed on an external website.

In addition to enabling this option when creating or editing the general settings of the build configuration, you need to include the following sections of code in the web page source:

  • The following code sample in the <head> section (alternatively, add parameter withCss=true to externalStatus.html): 

    <style type="text/css">
 @import" <path_to_server>/css/status/externalStatus.css";
</style>

  • Add the following code sample where you want to display the build configuration's status: 

    <script type="text/javascript" src="<path_to_server>/externalStatus.html?js=1">
</script>

  • If you prefer plan HTML text instead of javascript, omit the js=1 parameter.

  • If you want to include the default CSS styles without modifying the HEAD section, add the withCss=true parameter.

  • To provide information on the statuses of builds of specific build configurations, repeat the following parameter in the URL:

    &buildTypeId=<buildConfigurationId>

  • It is also possible to show the status of all of the build configurations in a project by replacing "&buildTypeId=<buildConfigurationId>" with "&projectId=<projectId>". You can select a combination of these parameters or omit them all so that all of the build configurations of all of the projects are displayed on your web page.

  • You can download the externalStatus.css file and customize its settings (for example, you can disable some columns with display: none; See comments in externalStatus.css). In this case, you must not include withCss=true parameter, but rather provide the CSS styles explicitly, preferably in the HEAD section.