Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jetbrains/teamcity-rest-client
Client for TeamCity REST API written in Kotlin
https://github.com/jetbrains/teamcity-rest-client
kotlin teamcity teamcity-rest-api
Last synced: 1 day ago
JSON representation
Client for TeamCity REST API written in Kotlin
- Host: GitHub
- URL: https://github.com/jetbrains/teamcity-rest-client
- Owner: JetBrains
- License: apache-2.0
- Created: 2015-04-06T16:40:25.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-12-02T13:53:58.000Z (about 2 months ago)
- Last Synced: 2025-01-18T21:43:17.127Z (8 days ago)
- Topics: kotlin, teamcity, teamcity-rest-api
- Language: Kotlin
- Size: 881 KB
- Stars: 74
- Watchers: 53
- Forks: 51
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# teamcity-rest-client [](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub) [](https://opensource.org/licenses/Apache-2.0) [/statusIcon.svg)](https://teamcity.jetbrains.com/viewType.html?buildTypeId=TeamCityRestApiClients_KotlinClient_Build&guest=1)
Client for TeamCity REST API written in Kotlin. The code snippet below will download `*.zip` artifacts from the latest successful build with tag `publish` of the specified build configuration to `out` directory using *coroutines non-blocking API*.
```kotlin
val docs = BuildConfigurationId("Kotlin_StandardLibraryDocumentation")
val build = TeamCityInstanceBuilder("https://teamcity.jetbrains.com").withGuestAuth().build()
.builds()
.fromConfiguration(docs)
.withTag("publish")
.latest() // suspending call
// suspending call
build!!.downloadArtifacts("*.zip", File("out"))
```
Another snippet will run a build on your own server using *coroutines non-blocking API*.
```kotlin
val tc = TeamCityInstanceBuilder("https://myserver.local")
.withHttpAuth("login", "password")
.build()
// suspending call
val buildConfiguration = tc.buildConfiguration(BuildConfigurationId("BuildConfId"))
// suspending call
val build = buildConfiguration.runBuild(
parameters = mapOf("myparameter1" to "value", "myparameter2" to "value")
)
```
Please note that repeated getter call on entities will return the same value because the result is cached:
```kotlin
val tc = TeamCityInstanceBuilder("https://myserver.local").withGuestAuth().build()
val build = tc.builds().latest()!!
val first = build.getState() // suspending call
delay(1000000L)
val second = build.getState() // fast call; won't suspend, returns cached value
assert(first == second) // the check will always pass, even if the build state has changed
```
*Blocking API* is also available for you.
```kotlin
val docs = BuildConfigurationId("Kotlin_StandardLibraryDocumentation")
val build = TeamCityInstanceBuilder("https://teamcity.jetbrains.com")
.withGuestAuth()
.buildBlockingInstance()
.builds()
.fromConfiguration(docs)
.withTag("publish")
.latest() // will block execution until response received
// will block execution until response received
build!!.downloadArtifacts("*.zip", File("out"))
```
# Published to Space
https://packages.jetbrains.team/maven/p/teamcity-rest-client/teamcity-rest-client
You can add the dependency in your build.gradle file:
```gradle
repositories {
maven {
url "https://packages.jetbrains.team/maven/p/teamcity-rest-client/teamcity-rest-client"
}
}
dependencies {
compile "org.jetbrains.teamcity:teamcity-rest-client:PACKAGE_VERSION"
}
```
# Deploy (JetBrains internal)
https://buildserver.labs.intellij.net/buildConfiguration/BuildUtils_TeamCityRestClient_Publish
# Contributing
Your contributions are welcome, please read the [CONTRIBUTING.md](CONTRIBUTING.md) for details.