codemc-api/io.codemc.api.jenkins

Package-level declarations

Types

JenkinsBuild

data class JenkinsBuild(val result: String, val number: Int, val url: String?, val timestamp: Long)

Represents a Jenkins build.

JenkinsConfig

data class JenkinsConfig(val url: String, val username: String, val token: String)

The Jenkins configuration.

JenkinsJob

data class JenkinsJob(val name: String, val url: String?, val description: String?, val lastBuild: JenkinsBuild?, val lastCompletedBuild: JenkinsBuild?, val lastFailedBuild: JenkinsBuild?, val lastStableBuild: JenkinsBuild?)

Represents a Jenkins job.

Properties

jenkinsConfig

lateinit var jenkinsConfig: JenkinsConfig

The JenkinsConfig instance.

NEXUS_CREDENTIALS_DESCRIPTION

const val NEXUS_CREDENTIALS_DESCRIPTION: String

The Jenkins Credentials Description for the Nexus Credentials.

NEXUS_CREDENTIALS_ID

const val NEXUS_CREDENTIALS_ID: String

The Jenkins Credentials ID for the Nexus Credentials.

Functions

changeJenkinsPassword

fun changeJenkinsPassword(username: String, newPassword: String): Boolean

Changes the Jenkins password for a user.

checkCredentials

fun checkCredentials(username: String, password: String)

Checks if the Jenkins credentials exist, and creates them if they don't.

checkUserConfig

fun checkUserConfig(username: String): Boolean

Checks the user config.xml present on the Jenkins CI.

createJenkinsJob

@JvmOverloads

fun createJenkinsJob(username: String, jobName: String, repoLink: String, isFreestyle: Boolean, config: (String) -> String = { it }): Boolean

Creates a Jenkins job.

createJenkinsUser

@JvmOverloads

fun createJenkinsUser(username: String, password: String, group: Boolean = false): Boolean

Creates a Jenkins user.

deleteJob

fun deleteJob(username: String, jobName: String): Boolean

Deletes a Jenkins job.

deleteUser

fun deleteUser(username: String): Boolean

Deletes a Jenkins user.

getAllJenkinsUsers

fun getAllJenkinsUsers(): List<String>

Gets all Jenkins users.

getJenkinsUser

fun getJenkinsUser(username: String): String

Gets a Jenkins user's configuration.

getJobInfo

fun getJobInfo(username: String, jobName: String): JenkinsJob?

Gets the information of a Jenkins job.

isFreestyle

fun isFreestyle(url: String): Boolean

Checks if a Git repository is a freestyle project.

jenkins

suspend fun jenkins(url: String, request: HttpRequest.Builder.() -> Unit = { GET() }): HttpResponse<String>

Sends an HTTP request using the JenkinsConfig.authorization header.

ping

fun ping(): Boolean

Pings the Jenkins server.

triggerBuild

fun triggerBuild(username: String, jobName: String): Boolean

Triggers a build for a Jenkins job.