Skip to content

GitLab CI Kotlin DSLopensavvy.gitlab.ciArtifactsannotations

annotations

fun annotations(path: String)

Collects annotations to attach auxiliary data to a job.

The annotations report is a JSON file with annotation sections that can contain external links and other auxiliary data displayed on the job output page.

Example

val deploy by job {
    script {
        shell("./deploy.sh")
        shell("echo '{\"links\": [{\"external_link\": {\"label\": \"Deployment URL\", \"url\": \"https://app.example.com\"}}]}' annotations.json")
    }

    artifacts {
        annotations("annotations.json")
    }
}

External resources