kotlin-actions-toolkit/actions.core

Package-level declarations

Types

AnnotationProperties

external interface AnnotationProperties

CommandProperties

typealias CommandProperties = Record<String, Any>

ExitCode

sealed external interface ExitCode

InputOptions

external interface InputOptions

OidcClient

external class OidcClient

Summary

external class Summary

SummaryImageOptions

external interface SummaryImageOptions

SummaryTableCell

external interface SummaryTableCell

SummaryTableRow

typealias SummaryTableRow = ReadonlyArray<Any>

SummaryWriteOptions

external interface SummaryWriteOptions

Properties

markdownSummary

external val markdownSummary: Summary

summary

external val summary: Summary

SUMMARY_DOCS_URL

const val SUMMARY_DOCS_URL: String

SUMMARY_ENV_VAR

const val SUMMARY_ENV_VAR: String

Functions

addPath

external fun addPath(inputPath: String)

debug

external fun debug(message: String)

endGroup

external fun endGroup()

error

external fun error(message: String, properties: AnnotationProperties = definedExternally)

external fun error(message: JsError, properties: AnnotationProperties = definedExternally)

exportVariable

external fun exportVariable(name: String, value: Any?)

getBooleanInput

external fun getBooleanInput(name: String, options: InputOptions = definedExternally): Boolean

getIDToken

suspend external fun getIDToken(aud: String = definedExternally): String

getIDTokenAsync

external fun getIDTokenAsync(aud: String = definedExternally): Promise<String>

getInput

external fun getInput(name: String, options: InputOptions = definedExternally): String

getMultilineInput

external fun getMultilineInput(name: String, options: InputOptions = definedExternally): ReadonlyArray<String>

getState

external fun getState(name: String): String

group

suspend external fun <T> group(name: String, fn: () -> Promise<T>): T

groupAsync

external fun <T> groupAsync(name: String, fn: () -> Promise<T>): Promise<T>

info

external fun info(message: String)

isDebug

external fun isDebug(): Boolean

issue

external fun issue(name: String, message: String = definedExternally)

issueCommand

external fun issueCommand(command: String, properties: CommandProperties, message: Any?)

issueFileCommand

external fun issueFileCommand(command: String, message: Any?)

notice

external fun notice(message: String, properties: AnnotationProperties = definedExternally)

external fun notice(message: JsError, properties: AnnotationProperties = definedExternally)

prepareKeyValueMessage

external fun prepareKeyValueMessage(key: String, value: Any?): String

saveState

external fun saveState(name: String, value: Any?)

setCommandEcho

external fun setCommandEcho(enabled: Boolean)

setFailed

external fun setFailed(message: String)

external fun setFailed(message: JsError)

setOutput

external fun setOutput(name: String, value: Any?)

setSecret

external fun setSecret(secret: String)

startGroup

external fun startGroup(name: String)

toCommandProperties

external fun toCommandProperties(annotationProperties: AnnotationProperties): CommandProperties

toCommandValue

external fun toCommandValue(input: Any?): String

toPlatformPath

external fun toPlatformPath(pth: String): String

toPosixPath

external fun toPosixPath(pth: String): String

toWin32Path

external fun toWin32Path(pth: String): String

warning

external fun warning(message: String, properties: AnnotationProperties = definedExternally)

external fun warning(message: JsError, properties: AnnotationProperties = definedExternally)