com.freeletics.gradle.scripts.CircleCiOptions.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scripts-circleci Show documentation

Collection of CircleCI related kts helpers

There is a newer version: 0.20.0

package com.freeletics.gradle.scripts

import com.github.ajalt.clikt.parameters.groups.OptionGroup
import com.github.ajalt.clikt.parameters.options.option
import com.github.ajalt.clikt.parameters.options.required

public class CircleCiOptions : OptionGroup("CircleCI options") {
    public val userName: String by option(
        "--project-username",
        envvar = "CIRCLE_PROJECT_USERNAME",
        help = "The username that this project belongs to",
    ).required()

    public val repoName: String by option(
        "--project-reponame",
        envvar = "CIRCLE_PROJECT_REPONAME",
        help = "The name of the repository for this project",
    ).required()

    public val repoSlug: String
        get() = "$userName/$repoName"

    public val jobUrl: String by option(
        "--job-url",
        envvar = "CIRCLE_BUILD_URL",
        help = "The url to the job",
    ).required()

    public val jobName: String by option(
        "--job-name",
        envvar = "CIRCLE_JOB",
        help = "The name of the job",
    ).required()

    public val buildNumber: String by option(
        "--build-number",
        envvar = "CIRCLE_BUILD_NUM",
        help = "The number of the job",
    ).required()

    public val branch: String by option(
        "--branch",
        envvar = "CIRCLE_BRANCH",
        help = "The branch that was built",
    ).required()

    public val commitSha1: String by option(
        "--commit-sha1",
        envvar = "CIRCLE_SHA1",
        help = "The sha1 of the commit that was built",
    ).required()
}