Icon

You are viewing the documentation of TeamCity 9.x, which is not the most recently released version of TeamCity.
View this page in the latest documentation or refer to the listing to choose the documentation corresponding to your TeamCity version.

 

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: fixed typo

...

TeamCity Open API is available as a set of Maven artifacts residing in the JetBrains Maven repository (http://repositorydownload.jetbrains.com/allteamcity-repository). Add this fragment to the <repositories> section of your pom file to access it:

Code Block
<repository>
  <id>jetbrains-all</id>
  <url>http://repositorydownload.jetbrains.com/all<teamcity-repository</url>
</repository>

Please note that only open API artifacts are present in the repository. If your plugin needs to use the not-open API, the corresponding jars should then be added to the project from the TeamCity distribution as they are not provided in the repository.

...

Here is the Maven command that will generate a project for a server-side-only plugin depending on 9.0 TeamCity version:

Code Block
xml
xml
mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate -DarchetypeRepository=http://repositorydownload.jetbrains.com/allteamcity-repository -DarchetypeArtifactId=teamcity-server-plugin -DarchetypeGroupId=org.jetbrains.teamcity.archetypes -DarchetypeVersion=RELEASE -DteamcityVersion=9.0

Here is the Maven command that will generate a project that contains both, the server and agent parts of a plugin and depends on 9.0 TeamCity version:

Code Block
xml
xml
mvn archetype:generate -DarchetypeRepository=http://repositorydownload.jetbrains.com/allteamcity-repository -DarchetypeArtifactId=teamcity-plugin -DarchetypeGroupId=org.jetbrains.teamcity.archetypes -DarchetypeVersion=RELEASE -DteamcityVersion=9.0

Here is the Maven command that will generate a sample project on 9.0 TeamCity version:

Code Block
xml
xml
mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate -DarchetypeRepository=http://repositorydownload.jetbrains.com/allteamcity-repository -DarchetypeArtifactId=teamcity-sample-plugin -DarchetypeGroupId=org.jetbrains.teamcity.archetypes -DarchetypeVersion=RELEASE -DteamcityVersion=9.0

You will be asked to enter the usual Maven groudId, artifactId and version for your plugin. Please note, that artifactId will be used as your plugin (internal) name.
After the project is generated, you may want to update teamcity-plugin.xml in the root directory: enter display name, description, author e-mail and other information.

...