TeamCity Integration for Jira

Space shortcuts

Page tree

Versions Compared

Old Version 77

changes.mady.by.user Vadim Rutkevich

Saved on

compared with

New Version Current

changes.mady.by.user Dmitry Trofimov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Numbered Headings
start-numbering-ath2

What JetBrains TeamCity versions are supported?

The latest TeamCity Integration for JIRA Jira Plugin supports TeamCity TeamCity 79.1-8.1.x.+.

In the table below you can find information about older releases of the add-on app and supported versions of TeamCity server.

Add-on Version1.7.01.7.1
Supported TeamCity Version6.5 - 8.17.1 - 8.1

 

app Version2.0.x2.1.0-2.5.x2.6.0, 2.6.12.6.2+2.7.0-3.0.43.2.0+
Supported TeamCity Version8.1-108.1-108.1-109.1+2017+2017+
Supported Jira Version6.1-6.4.x7.0.x-7.1.x7.2+7.2+7.2-7.13.X8.X+

Does the plugin store the build data anywhere?

The add-on app indexes TeamCity data only once, then it just re-indexes the updated data.

How can I get the plugin to show

JIRA

Jira info in TeamCity?

The plugin installs on JIRA Jira and shows TeamCity builds in JIRAJira. It doesn't work the other way round.

I configured TeamCity and

JIRA

Jira and installed the plugin. Why I don't see the TeamCity tab in

JIRA

Jira?

Most likely your JIRA Jira user doesn't have the permission to View Issue Source Tab (JIRA Jira 6.1 and below) or View Development Tools (JIRA Jira 6.2 and above).

How do I regulate visibility of the TeamCity tab for specific projects in Jira 7.X and 8.X?

You can regulate visibility of the TeamCity tab for specific Jira projects by adding or removing the View Development Tool permission in the project security schemes. Availability of this permission in the security scheme enables display of the TeamCity tab.

Why does the TeamCity tab show 'No associated builds are found'?

It means that no builds are associated with the current issue or project. Ensure that every contributor specifies issue keys while committing the program code. Normally, it's specified in a commit log message in a version control system integrated with TeamCity.

Info
iconfalse

For example, a developer commits a source code file adding the log message  DEMO-5 Added compatibility with older browser versions,    the build that includes this change will be shown in JIRA Jira in the DEMO project and in issue DEMO-5.

Everything runs smoothly and there're no errors in logs, but I see No builds found for some projects. Why?

The TeamCity user specified in the Application Link in JIRA Jira does not have access to all projects. Log in to TeamCity using these credentials and check if you see the necessary projects.

Also check whether linking between builds and issues is set up for these projects in Issue Tracker Integration in TeamCity.

Why does the indexation take so long?

It may take quite a long time, if your TeamCity server has lots of builds.

However, if you feel that it takes longer than it should, please go to  Administration > Add-ons apps > TeamCity Configuration > Troubleshooting  and see if there ar e are any errors. Freezing at 0% for a long time might mean that you have a problem with connecting TeamCity and JIRAJira.

Something went wrong during the build indexation. Where can I see the error log?

Go to  Administration > Add-ons apps > TeamCity Configuration > Troubleshooting. For the details on the displayed error, see the Indexing TeamCity Data page.

You can also adjust parameters of build indexation if you experience any issues.

If you need further assistance in case of errors, please contact us.

I created an Application Link. Now, I'm trying to create a Project Link, but something is not right. What

gives

do I do next?

You don't need a Project Link for the plugin to work. With the Application Link correctly configured, the plugin will assign all builds containing Issue Keys to corresponding projects.

JIRA

.

Can I show the build number on cards on Scrum and Kanban boards?

Yes. You can customize the look of cards and add the Fixed in build field into the card layout.

Can I view the number of build which addresses the issue in Issue Navigator?

Yes. You can add the Fixed in build column into the layout of Issue Navigator.

Jira and TeamCity reside in the same network and connect to the Internet via a proxy. Why can't

JIRA

Jira connect to TeamCity? 

If JIRA Jira is configured to use a proxy, it tries to connect to TeamCity via a proxy even if the TeamCity server is in the same network. The proxy server could block this connection.

For the details on this issue, refer to this page .

The

JIRA

Jira Base URL was changed. Why do

JIRA

Jira issues in the TeamCity tabs still have the old URL?

Make sure that the new URL is specified in Issue Tracker Integration in TeamCity and reindex the builds in JIRAJira's Administration > Add-ons apps > TeamCity Configuration > Troubleshooting.

What happens in case of network problems during the initial indexation?

Initially, the plugin indexes builds by packages of 20 builds. If during the initial indexation, the plugin can't access TeamCity, it will keep trying to index the build package next to the last successfully indexed one.

If the Skip Builds option is enabled in Administration > Add-ons apps > TeamCity Configuration > Global Configuration, the plugin will skip the builds that can't be indexed due to network or other problems.

What happens if the connection to TeamCity is lost after the initial indexation?

After the initial build index is created, the plugin updates it every 2 minutes. In case it can't connect to TeamCity, the plugin will keep trying to reach it every 2 minutes until it succeeds.

If the Skip Builds option is enabled in Administration > Add-ons apps > TeamCity Configuration > Global Configuration, the plugin will skip the builds that can't be indexed due to network or other problems.

Why may I need to reindex all TeamCity builds?

If the plugin doesn't show builds that you're sure should be shown, reindex the build list completely. To do that, go to Administration > Add-ons apps > TeamCity Configuration > Troubleshooting and click the  Reindex button. Please note that reindexation will start from scratch and can take a while on large instances.

  

How do I turn on logging?

In Administration > System > System Support (Troubleshooting and Support in Jira versions prior to Jira 8) > Logging & Profiling, set the DEBUG level for the following packages:

  • com.stiltsoft.jira.extra.teamcity.index
  • com.stiltsoft.lib.teamcity.connector.rest

Optionally, you can do the same for com.stiltsoft.lib.teamcity.connector.util , but this may significantly slow down your JIRA Jira instance and make a mess of your log.

The com.stiltsoft.jira.extra.teamcity.index package outputs the following data in the logs:

Code Block
[INFO] [talledLocalContainer] 2014-04-08 13:16:29,973 pool-17-thread-1 DEBUG ServiceRunner    com.stiltsoft.jira.extra.teamcity.index.sal.TeamCityIndexing:job [extra.teamcity.index.IndexUpdaterImpl]  --> updateIndexInitial(app-link-name) /httpAuth/app/rest/builds?count=20&start=2020

[INFO] [talledLocalContainer] 2014-04-08 13:16:38,851 pool-17-thread-1 DEBUG ServiceRunner    com.stiltsoft.jira.extra.teamcity.index.sal.TeamCityIndexing:job [extra.teamcity.index.IndexUpdaterImpl]  --> updateIndexInitial(app-link-name) /httpAuth/app/rest/builds?count=20&start=2040

The com.stiltsoft.lib.teamcity.connector.rest package outputs the following data in the logs:

Code Block
[INFO] [talledLocalContainer] 2014-04-08 13:14:24,684 pool-17-thread-1 DEBUG ServiceRunner    com.stiltsoft.jira.extra.teamcity.index.sal.TeamCityIndexing:job [teamcity.connector.rest.RestClient] Request: TCServer{appLinkId='ed9de4d0-1be9-3380-9980-bf14e1548314', url='http://teamcity.stiltsoft.com/'}/httpAuth/app/rest/builds/id:123947?

[INFO] [talledLocalContainer] 2014-04-08 13:14:24,882 pool-17-thread-1 DEBUG ServiceRunner    com.stiltsoft.jira.extra.teamcity.index.sal.TeamCityIndexing:job [teamcity.connector.rest.RestClient] Request: TCServer{appLinkId='ed9de4d0-1be9-3380-9980-bf14e1548314', url='http://teamcity.stiltsoft.com/'}/httpAuth/app/rest/builds/id:123947/relatedIssues?

Logging of packages works temporarily until the JIRA Jira restart.

For permanent package logging you need to locate the log4j.properties file (see this page for file location) and add into it the following strings:

Code Block
log4j.logger.com.stiltsoft.lib.teamcity.connector.rest = DEBUG, console, filelog
log4j.additivity.com.stiltsoft.lib.teamcity.connector.rest = false

Where instead of com.stiltsoft.lib.teamcity.connector.rest can be any of the packages mentioned above.

Note

For the details on where to find JIRA Jira logs, refer to this page.

What should I do if there are a lot of app errors in Jira log?

  1. Enable the DEBUG mode for the com.stiltsoft.lib.teamcity.connector.rest packet. See the How do I turn on logging? section for details.

  2. Wait for half an hour.

  3. Send a portion of Jira logs for the last hour to us.

  4. Provide the screenshot of the page with the created application links.

  5. Let us know versions of your Jira, TeamCity and installed app.

Why do I not see the TeamCity tab for some projects in Jira 7?

Starting from version 2.1.0, the app shows the TeamCity tab only in Software and Service Desk projects (Jira Software and Jira Service Desk). The dedicated tab is not available in business projects (Jira Core).

Why does the TeamCity Build Runner field fail to trigger build execution in newer TeamCity versions?

You may experience issues with triggering builds through the TeamCity Build Runner custom field, post function in Jira, or TeamCity Build Configurations Gadget.

The issue occurs with TeamCity 2017.x or newer. To resolve this issue, please see TeamCity documentation for details or follow the steps below:

  1. Log as as administrator in to TeamCity.
  2. Navigate to Administration > Server Administration > Diagnostics.
  3. Switch to the  Internal Properties tab.
  4. Locate the config/internal.properties file.
  5. Click Edit.
  6. Add the parameter with the URL of your Jira host: for example, rest.cors.origins=https://yourjira.com (You may enter multiple hosts and separate them with a comma).
  7. Save the modified properties.

No build data is available after the successful setup and data indexation when using IIS for running TeamCity

You may encounter this issue when your TeamCity operates on the basis of Microsoft's IIS. After the successful app setup, its configuration, and initial data indexation you may find no build data in Jira issues.

The issue is caused primarily by special characters that IIS may treat as invalid when performing HTTP requests to TeamCity. TeamCity REST API uses colon (':') for processing requests that fetch information about related issues, as follows:

Code Block
https://teamcity.jetbrains.com/httpAuth/app/rest/builds/id:799596/relatedIssues?fields=issueUsage(issue)

resolve this issue, please do the following:

  1. Locate the web.config file on the IIS server and open it.

  2. Add or edit the RequestPathInvalidCharacters property (if it already exists).

  3. Remove the unnecessary characters that should not be treated as invalid by IIS, as follows:
Code Block
<system.web>
	<httpRuntime requestPathInvalidCharacters="<,>,*" />
</system.web>

Optionally, you can remove all of them. Prior to doing this, consult the infrastructure support or data security team for any possible impacts of this in your corporate environment.