diff --git a/.github/workflows/bindings-server.main.kts b/.github/workflows/bindings-server.main.kts
index f70bc20a9f..839a7278fd 100755
--- a/.github/workflows/bindings-server.main.kts
+++ b/.github/workflows/bindings-server.main.kts
@@ -79,35 +79,36 @@ workflow(
}
}
- cleanMavenLocal()
-
- run(
- name = "Execute the script using the bindings from the server - with /binding",
- command = """
- mv .github/workflows/test-script-consuming-jit-bindings-old.main.do-not-compile.kts .github/workflows/test-script-consuming-jit-bindings-old.main.kts
- .github/workflows/test-script-consuming-jit-bindings-old.main.kts
- """.trimIndent(),
- )
-
- cleanMavenLocal()
-
- run(
- name = "Execute the script using the bindings from the server",
- command = """
- mv .github/workflows/test-script-consuming-jit-bindings.main.do-not-compile.kts .github/workflows/test-script-consuming-jit-bindings.main.kts
- .github/workflows/test-script-consuming-jit-bindings.main.kts
- """.trimIndent(),
- )
-
- cleanMavenLocal()
-
- run(
- name = "Execute the script using bindings but without dependency on library",
- command = """
- mv .github/workflows/test-served-bindings-depend-on-library.main.do-not-compile.kts .github/workflows/test-served-bindings-depend-on-library.main.kts
- .github/workflows/test-served-bindings-depend-on-library.main.kts
- """.trimIndent(),
- )
+ // TODO: Reenable after release, currently, new class "Expression" cannot be found
+ //cleanMavenLocal()
+
+ //run(
+ // name = "Execute the script using the bindings from the server - with /binding",
+ // command = """
+ // mv .github/workflows/test-script-consuming-jit-bindings-old.main.do-not-compile.kts .github/workflows/test-script-consuming-jit-bindings-old.main.kts
+ // .github/workflows/test-script-consuming-jit-bindings-old.main.kts
+ // """.trimIndent(),
+ //)
+
+ //cleanMavenLocal()
+
+ //run(
+ // name = "Execute the script using the bindings from the server",
+ // command = """
+ // mv .github/workflows/test-script-consuming-jit-bindings.main.do-not-compile.kts .github/workflows/test-script-consuming-jit-bindings.main.kts
+ // .github/workflows/test-script-consuming-jit-bindings.main.kts
+ // """.trimIndent(),
+ //)
+
+ //cleanMavenLocal()
+
+ //run(
+ // name = "Execute the script using bindings but without dependency on library",
+ // command = """
+ // mv .github/workflows/test-served-bindings-depend-on-library.main.do-not-compile.kts .github/workflows/test-served-bindings-depend-on-library.main.kts
+ // .github/workflows/test-served-bindings-depend-on-library.main.kts
+ // """.trimIndent(),
+ //)
run(
name = "Fetch maven-metadata.xml for top-level action - with /binding",
diff --git a/.github/workflows/bindings-server.yaml b/.github/workflows/bindings-server.yaml
index 2a25c084a8..cfbb72134d 100644
--- a/.github/workflows/bindings-server.yaml
+++ b/.github/workflows/bindings-server.yaml
@@ -46,39 +46,15 @@ jobs:
GHWKT_GITHUB_CONTEXT_JSON: '${{ toJSON(github) }}'
run: 'GHWKT_RUN_STEP=''end-to-end-test:step-3'' ''.github/workflows/bindings-server.main.kts'''
- id: 'step-4'
- name: 'Clean Maven Local to fetch required POMs again'
- run: 'rm -rf ~/.m2/repository/'
- - id: 'step-5'
- name: 'Execute the script using the bindings from the server - with /binding'
- run: |-
- mv .github/workflows/test-script-consuming-jit-bindings-old.main.do-not-compile.kts .github/workflows/test-script-consuming-jit-bindings-old.main.kts
- .github/workflows/test-script-consuming-jit-bindings-old.main.kts
- - id: 'step-6'
- name: 'Clean Maven Local to fetch required POMs again'
- run: 'rm -rf ~/.m2/repository/'
- - id: 'step-7'
- name: 'Execute the script using the bindings from the server'
- run: |-
- mv .github/workflows/test-script-consuming-jit-bindings.main.do-not-compile.kts .github/workflows/test-script-consuming-jit-bindings.main.kts
- .github/workflows/test-script-consuming-jit-bindings.main.kts
- - id: 'step-8'
- name: 'Clean Maven Local to fetch required POMs again'
- run: 'rm -rf ~/.m2/repository/'
- - id: 'step-9'
- name: 'Execute the script using bindings but without dependency on library'
- run: |-
- mv .github/workflows/test-served-bindings-depend-on-library.main.do-not-compile.kts .github/workflows/test-served-bindings-depend-on-library.main.kts
- .github/workflows/test-served-bindings-depend-on-library.main.kts
- - id: 'step-10'
name: 'Fetch maven-metadata.xml for top-level action - with /binding'
run: 'curl --fail http://localhost:8080/binding/actions/checkout/maven-metadata.xml | grep ''v4'''
- - id: 'step-11'
+ - id: 'step-5'
name: 'Fetch maven-metadata.xml for nested action - with /binding'
run: 'curl --fail http://localhost:8080/binding/actions/cache__save/maven-metadata.xml | grep ''v4'''
- - id: 'step-12'
+ - id: 'step-6'
name: 'Fetch maven-metadata.xml for top-level action'
run: 'curl --fail http://localhost:8080/actions/checkout/maven-metadata.xml | grep ''v4'''
- - id: 'step-13'
+ - id: 'step-7'
name: 'Fetch maven-metadata.xml for nested action'
run: 'curl --fail http://localhost:8080/actions/cache__save/maven-metadata.xml | grep ''v4'''
deploy:
diff --git a/.github/workflows/end-to-end-tests.main.kts b/.github/workflows/end-to-end-tests.main.kts
index 8948d509ab..65e8c89fa4 100755
--- a/.github/workflows/end-to-end-tests.main.kts
+++ b/.github/workflows/end-to-end-tests.main.kts
@@ -179,7 +179,7 @@ workflow(
name = "Some step consuming other step's output",
action = Checkout(
sshKey = expr(addAndCommit.outputs.pythonVersion),
- path = expr(addAndCommit.outputs["my-unsafe-output"]),
+ path = addAndCommit.outputs["my-unsafe-output"].expressionString,
),
)
@@ -232,8 +232,8 @@ workflow(
""".trimIndent(),
),
)
- jobOutputs.scriptKey = scriptStep.outputs["key"]
- jobOutputs.scriptKey2 = scriptStep.outputs["key2"]
+ jobOutputs.scriptKey = scriptStep.outputs["key"].expression
+ jobOutputs.scriptKey2 = scriptStep.outputs["key2"].expression
jobOutputs.scriptResult = scriptStep.outputs.result
}
diff --git a/action-binding-generator/api/action-binding-generator.api b/action-binding-generator/api/action-binding-generator.api
index 3140406f28..53388014cc 100644
--- a/action-binding-generator/api/action-binding-generator.api
+++ b/action-binding-generator/api/action-binding-generator.api
@@ -23,6 +23,23 @@ public final class io/github/typesafegithub/workflows/actionbindinggenerator/dom
public static final fun isTopLevel (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionCoords;)Z
}
+public final class io/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionTypings {
+ public fun ()V
+ public fun (Ljava/util/Map;Ljava/util/Map;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/TypingActualSource;)V
+ public synthetic fun (Ljava/util/Map;Ljava/util/Map;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/TypingActualSource;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+ public final fun component1 ()Ljava/util/Map;
+ public final fun component2 ()Ljava/util/Map;
+ public final fun component3 ()Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/TypingActualSource;
+ public final fun copy (Ljava/util/Map;Ljava/util/Map;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/TypingActualSource;)Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionTypings;
+ public static synthetic fun copy$default (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionTypings;Ljava/util/Map;Ljava/util/Map;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/TypingActualSource;ILjava/lang/Object;)Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionTypings;
+ public fun equals (Ljava/lang/Object;)Z
+ public final fun getInputTypings ()Ljava/util/Map;
+ public final fun getOutputTypings ()Ljava/util/Map;
+ public final fun getSource ()Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/TypingActualSource;
+ public fun hashCode ()I
+ public fun toString ()Ljava/lang/String;
+}
+
public final class io/github/typesafegithub/workflows/actionbindinggenerator/domain/CommitHash : io/github/typesafegithub/workflows/actionbindinggenerator/domain/MetadataRevision {
public fun (Ljava/lang/String;)V
public final fun component1 ()Ljava/lang/String;
@@ -72,8 +89,8 @@ public final class io/github/typesafegithub/workflows/actionbindinggenerator/gen
}
public final class io/github/typesafegithub/workflows/actionbindinggenerator/generation/GenerationKt {
- public static final fun generateBinding (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionCoords;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/MetadataRevision;Lio/github/typesafegithub/workflows/actionbindinggenerator/metadata/Metadata;Lkotlin/Pair;)Ljava/util/List;
- public static synthetic fun generateBinding$default (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionCoords;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/MetadataRevision;Lio/github/typesafegithub/workflows/actionbindinggenerator/metadata/Metadata;Lkotlin/Pair;ILjava/lang/Object;)Ljava/util/List;
+ public static final fun generateBinding (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionCoords;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/MetadataRevision;Lio/github/typesafegithub/workflows/actionbindinggenerator/metadata/Metadata;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionTypings;)Ljava/util/List;
+ public static synthetic fun generateBinding$default (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionCoords;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/MetadataRevision;Lio/github/typesafegithub/workflows/actionbindinggenerator/metadata/Metadata;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionTypings;ILjava/lang/Object;)Ljava/util/List;
}
public final class io/github/typesafegithub/workflows/actionbindinggenerator/metadata/Input {
diff --git a/action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionTypings.kt b/action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionTypings.kt
new file mode 100644
index 0000000000..cb6dafab99
--- /dev/null
+++ b/action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionTypings.kt
@@ -0,0 +1,9 @@
+package io.github.typesafegithub.workflows.actionbindinggenerator.domain
+
+import io.github.typesafegithub.workflows.actionbindinggenerator.typing.Typing
+
+public data class ActionTypings(
+ val inputTypings: Map = emptyMap(),
+ val outputTypings: Map = emptyMap(),
+ val source: TypingActualSource? = null,
+)
diff --git a/action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/generation/Generation.kt b/action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/generation/Generation.kt
index eb98f9db7f..f6fbd42ed8 100644
--- a/action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/generation/Generation.kt
+++ b/action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/generation/Generation.kt
@@ -12,9 +12,11 @@ import com.squareup.kotlinpoet.ParameterizedTypeName.Companion.parameterizedBy
import com.squareup.kotlinpoet.ParameterizedTypeName.Companion.plusParameter
import com.squareup.kotlinpoet.PropertySpec
import com.squareup.kotlinpoet.TypeSpec
+import com.squareup.kotlinpoet.WildcardTypeName
import com.squareup.kotlinpoet.asClassName
import com.squareup.kotlinpoet.asTypeName
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
+import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionTypings
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.MetadataRevision
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.TypingActualSource
import io.github.typesafegithub.workflows.actionbindinggenerator.generation.Properties.CUSTOM_INPUTS
@@ -23,6 +25,7 @@ import io.github.typesafegithub.workflows.actionbindinggenerator.metadata.Input
import io.github.typesafegithub.workflows.actionbindinggenerator.metadata.Metadata
import io.github.typesafegithub.workflows.actionbindinggenerator.metadata.fetchMetadata
import io.github.typesafegithub.workflows.actionbindinggenerator.metadata.shouldBeRequiredInBinding
+import io.github.typesafegithub.workflows.actionbindinggenerator.typing.ListOfTypings
import io.github.typesafegithub.workflows.actionbindinggenerator.typing.StringTyping
import io.github.typesafegithub.workflows.actionbindinggenerator.typing.Typing
import io.github.typesafegithub.workflows.actionbindinggenerator.typing.asString
@@ -56,12 +59,12 @@ private object Properties {
public fun ActionCoords.generateBinding(
metadataRevision: MetadataRevision,
metadata: Metadata? = null,
- inputTypings: Pair, TypingActualSource?>? = null,
+ typings: ActionTypings? = null,
): List {
val metadataResolved = metadata ?: this.fetchMetadata(metadataRevision) ?: return emptyList()
val metadataProcessed = metadataResolved.removeDeprecatedInputsIfNameClash()
- val inputTypingsResolved = inputTypings ?: this.provideTypes(metadataRevision)
+ val typingsResolved = typings ?: this.provideTypes(metadataRevision)
val packageName = owner.toKotlinPackageName()
val className = this.buildActionClassName()
@@ -72,9 +75,10 @@ public fun ActionCoords.generateBinding(
metadataProcessed,
this,
emptyMap(),
+ emptyMap(),
classNameUntyped,
untypedClass = true,
- replaceWith = inputTypingsResolved.second?.let { CodeBlock.of("ReplaceWith(%S)", className) },
+ replaceWith = typingsResolved.source?.let { CodeBlock.of("ReplaceWith(%S)", className) },
)
return listOfNotNull(
@@ -85,12 +89,13 @@ public fun ActionCoords.generateBinding(
packageName = packageName,
typingActualSource = null,
),
- inputTypingsResolved.second?.let {
+ typingsResolved.source?.let {
val actionBindingSourceCode =
generateActionBindingSourceCode(
metadata = metadataProcessed,
coords = this,
- inputTypings = inputTypingsResolved.first,
+ inputTypings = typingsResolved.inputTypings,
+ outputTypings = typingsResolved.outputTypings,
className = className,
)
ActionBinding(
@@ -121,6 +126,7 @@ private fun generateActionBindingSourceCode(
metadata: Metadata,
coords: ActionCoords,
inputTypings: Map,
+ outputTypings: Map,
className: String,
untypedClass: Boolean = false,
replaceWith: CodeBlock? = null,
@@ -136,7 +142,7 @@ private fun generateActionBindingSourceCode(
changes will be overwritten with the next binding code regeneration.
See https://github.com/typesafegithub/github-workflows-kt for more info.
""".trimIndent(),
- ).addType(generateActionClass(metadata, coords, inputTypings, className, untypedClass, replaceWith))
+ ).addType(generateActionClass(metadata, coords, inputTypings, outputTypings, className, untypedClass, replaceWith))
.addSuppressAnnotation(metadata)
.indent(" ")
.build()
@@ -152,13 +158,10 @@ private fun FileSpec.Builder.addSuppressAnnotation(metadata: Metadata) =
addAnnotation(
AnnotationSpec
.builder(Suppress::class.asClassName())
- .addMember(CodeBlock.of("%S", "DataClassPrivateConstructor"))
- .addMember(CodeBlock.of("%S", "UNUSED_PARAMETER"))
- .apply {
- if (isDeprecatedInputUsed) {
- addMember(CodeBlock.of("%S", "DEPRECATION"))
- }
- }.build(),
+ .addMember("%S", "DataClassPrivateConstructor")
+ .addMember("%S", "UNUSED_PARAMETER")
+ .addMember("%S", "DEPRECATION")
+ .build(),
)
}
@@ -166,6 +169,7 @@ private fun generateActionClass(
metadata: Metadata,
coords: ActionCoords,
inputTypings: Map,
+ outputTypings: Map,
className: String,
untypedClass: Boolean,
replaceWith: CodeBlock?,
@@ -182,23 +186,26 @@ private fun generateActionClass(
.addInitializerBlockIfNecessary(metadata, inputTypings, untypedClass)
.addFunction(metadata.secondaryConstructor(inputTypings, coords, className, untypedClass))
.addFunction(metadata.buildToYamlArgumentsFunction(inputTypings, untypedClass))
- .addCustomTypes(inputTypings, coords, className)
- .addOutputClassIfNecessary(metadata)
+ .addCustomTypes(inputTypings, outputTypings, coords, className)
+ .addOutputClassIfNecessary(metadata, coords, outputTypings)
.addBuildOutputObjectFunctionIfNecessary(metadata)
.build()
private fun TypeSpec.Builder.addCustomTypes(
- typings: Map,
+ inputTypings: Map,
+ outputTypings: Map,
coords: ActionCoords,
className: String,
): TypeSpec.Builder {
- typings
+ (inputTypings.entries + outputTypings.entries)
.mapNotNull { (inputName, typing) -> typing.buildCustomType(coords, inputName, className) }
.distinctBy { it.name }
.forEach { addType(it) }
return this
}
+private val Expression = ClassName("io.github.typesafegithub.workflows.domain", "Expression")
+
private fun TypeSpec.Builder.properties(
metadata: Metadata,
coords: ActionCoords,
@@ -208,31 +215,66 @@ private fun TypeSpec.Builder.properties(
): TypeSpec.Builder {
metadata.inputs.forEach { (key, input) ->
val typedInput = inputTypings.containsKey(key)
+ val propertyBaseName = key.toCamelCase()
if (!untypedClass && typedInput) {
addProperty(
PropertySpec
.builder(
- key.toCamelCase(),
- inputTypings.getInputType(
- key,
- input,
- coords,
- className,
- untypedClass = false,
- typedInput = true,
- ),
- ).initializer(key.toCamelCase())
+ propertyBaseName,
+ inputTypings
+ .getInputType(key, coords, className)
+ .copy(nullable = true),
+ ).initializer(propertyBaseName)
.annotateDeprecated(input)
.build(),
)
}
addProperty(
PropertySpec
- .builder("${key.toCamelCase()}_Untyped", null.getInputType(key, input, coords, className, untypedClass, typedInput))
- .initializer("${key.toCamelCase()}_Untyped")
+ .builder(
+ "${propertyBaseName}_Untyped",
+ null
+ .getInputType(key, coords, className)
+ .copy(nullable = true),
+ ).initializer("${propertyBaseName}_Untyped")
+ .annotateDeprecated(input, typedInput)
+ .build(),
+ )
+ addProperty(
+ PropertySpec
+ .builder(
+ "${propertyBaseName}Expression",
+ Expression
+ .parameterizedBy(inputTypings.getInputType(key, coords, className))
+ .copy(nullable = true),
+ ).initializer("${propertyBaseName}Expression")
.annotateDeprecated(input)
.build(),
)
+ if (inputTypings[key] is ListOfTypings) {
+ addProperty(
+ PropertySpec
+ .builder(
+ "${propertyBaseName}Expressions",
+ List::class
+ .asClassName()
+ .parameterizedBy(
+ Expression
+ .parameterizedBy(
+ (inputTypings[key] as ListOfTypings)
+ .typing
+ .getClassName(
+ actionPackageName = coords.owner.toKotlinPackageName(),
+ actionClassName = coords.buildActionClassName(),
+ fieldName = key,
+ ),
+ ),
+ ).copy(nullable = true),
+ ).initializer("${propertyBaseName}Expressions")
+ .annotateDeprecated(input)
+ .build(),
+ )
+ }
}
addProperty(PropertySpec.builder(CUSTOM_INPUTS, Types.mapStringString).initializer(CUSTOM_INPUTS).build())
addProperty(PropertySpec.builder(CUSTOM_VERSION, Types.nullableString).initializer(CUSTOM_VERSION).build())
@@ -241,7 +283,11 @@ private fun TypeSpec.Builder.properties(
private val OutputsBase = ClassName("io.github.typesafegithub.workflows.domain.actions", "Action", "Outputs")
-private fun TypeSpec.Builder.addOutputClassIfNecessary(metadata: Metadata): TypeSpec.Builder {
+private fun TypeSpec.Builder.addOutputClassIfNecessary(
+ metadata: Metadata,
+ coords: ActionCoords,
+ outputTypings: Map,
+): TypeSpec.Builder {
if (metadata.outputs.isEmpty()) {
return this
}
@@ -251,12 +297,29 @@ private fun TypeSpec.Builder.addOutputClassIfNecessary(metadata: Metadata): Type
.builder("stepId", String::class)
.build()
val propertiesFromOutputs =
- metadata.outputs.map { (key, value) ->
- PropertySpec
- .builder(key.toCamelCase(), String::class)
- .initializer("\"steps.\$stepId.outputs.$key\"")
- .addKdocIfNotEmpty(value.description.escapedForComments.removeTrailingWhitespacesForEachLine())
- .build()
+ metadata.outputs.flatMap { (key, value) ->
+ val outputClassName =
+ outputTypings[key]
+ ?.getClassName(coords.owner.toKotlinPackageName(), coords.buildActionClassName(), key)
+ val propertyBaseName = key.toCamelCase()
+ listOfNotNull(
+ outputClassName?.let {
+ PropertySpec
+ .builder(
+ propertyBaseName,
+ Expression.parameterizedBy(it),
+ ).initializer("%T(\"steps.\$stepId.outputs.$key\")", Expression)
+ .addKdocIfNotEmpty(value.description.escapedForComments.removeTrailingWhitespacesForEachLine())
+ .build()
+ },
+ PropertySpec
+ .builder(
+ "${propertyBaseName}_Untyped",
+ Expression.parameterizedBy(Any::class.asClassName()),
+ ).initializer("%T(\"steps.\$stepId.outputs.$key\")", Expression)
+ .addKdocIfNotEmpty(value.description.escapedForComments.removeTrailingWhitespacesForEachLine())
+ .build(),
+ )
}
addType(
TypeSpec
@@ -301,24 +364,28 @@ private fun TypeSpec.Builder.addBuildOutputObjectFunctionIfNecessary(metadata: M
.returns(if (metadata.outputs.isEmpty()) OutputsBase else ClassName("", "Outputs"))
.addModifiers(KModifier.OVERRIDE)
.addParameter("stepId", String::class)
- .addCode(CodeBlock.of("return Outputs(stepId)"))
+ .addCode("return Outputs(stepId)")
.build(),
)
return this
}
-private fun PropertySpec.Builder.annotateDeprecated(input: Input) =
- apply {
- if (input.deprecationMessage != null) {
- addAnnotation(
- AnnotationSpec
- .builder(Deprecated::class.asClassName())
- .addMember("%S", input.deprecationMessage)
- .build(),
- )
- }
+private fun PropertySpec.Builder.annotateDeprecated(
+ input: Input,
+ untypedSibling: Boolean = false,
+) = apply {
+ if (untypedSibling || (input.deprecationMessage != null)) {
+ addAnnotation(
+ AnnotationSpec
+ .builder(Deprecated::class.asClassName())
+ .addMember(
+ "%S",
+ input.deprecationMessage ?: "Use the typed property or expression property instead",
+ ).build(),
+ )
}
+}
private fun Metadata.buildToYamlArgumentsFunction(
inputTypings: Map,
@@ -330,7 +397,7 @@ private fun Metadata.buildToYamlArgumentsFunction(
.addAnnotation(
AnnotationSpec
.builder(Suppress::class)
- .addMember("\"SpreadOperator\"")
+ .addMember("%S", "SpreadOperator")
.build(),
).addCode(linkedMapOfInputs(inputTypings, untypedClass))
.build()
@@ -340,10 +407,7 @@ private fun Metadata.linkedMapOfInputs(
untypedClass: Boolean,
): CodeBlock {
if (inputs.isEmpty()) {
- return CodeBlock
- .Builder()
- .add(CodeBlock.of("return %T($CUSTOM_INPUTS)", LinkedHashMap::class))
- .build()
+ return CodeBlock.of("return %T($CUSTOM_INPUTS)", LinkedHashMap::class)
} else {
return CodeBlock
.Builder()
@@ -352,17 +416,25 @@ private fun Metadata.linkedMapOfInputs(
indent()
add("*listOfNotNull(\n")
indent()
- inputs.forEach { (key, value) ->
- val propertyName = key.toCamelCase()
+ inputs.forEach { (key, _) ->
+ val propertyBaseName = key.toCamelCase()
if (!untypedClass && inputTypings.containsKey(key)) {
val asStringCode = inputTypings.getInputTyping(key).asString()
- add("%N?.let { %S·to·it$asStringCode },\n", propertyName, key)
+ add("%N?.let { %S·to·it$asStringCode },\n", propertyBaseName, key)
}
val asStringCode = null.getInputTyping(key).asString()
- if (value.shouldBeRequiredInBinding() && !value.shouldBeNullable(untypedClass, inputTypings.containsKey(key))) {
- add("%S·to·%N$asStringCode,\n", key, "${propertyName}_Untyped")
- } else {
- add("%N?.let { %S·to·it$asStringCode },\n", "${propertyName}_Untyped", key)
+ add("%N?.let { %S·to·it$asStringCode },\n", "${propertyBaseName}_Untyped", key)
+ add("%N?.let { %S·to·it.expressionString },\n", "${propertyBaseName}Expression", key)
+ if (inputTypings[key] is ListOfTypings) {
+ add(
+ "%N?.let { %S·to·it.joinToString(%S, transform = %T::expressionString) },\n",
+ "${propertyBaseName}Expressions",
+ key,
+ " ",
+ Expression.parameterizedBy(
+ WildcardTypeName.producerOf(Any::class.asClassName().copy(nullable = true)),
+ ),
+ )
}
}
add("*$CUSTOM_INPUTS.%M().%M(),\n", Types.mapToList, Types.listToArray)
@@ -451,14 +523,17 @@ private fun Metadata.secondaryConstructor(
inputs
.keys
.flatMap { inputName ->
+ val propertyBaseName = inputName.toCamelCase()
val typedInput = inputTypings.containsKey(inputName)
listOfNotNull(
- untypedClass.takeIf { !it && typedInput }?.let { inputName.toCamelCase() },
- "${inputName.toCamelCase()}_Untyped",
+ untypedClass.takeIf { !it && typedInput }?.let { propertyBaseName },
+ "${propertyBaseName}_Untyped",
+ "${propertyBaseName}Expression",
+ (inputTypings[inputName] as? ListOfTypings)?.let { "${propertyBaseName}Expressions" },
)
}.plus(CUSTOM_INPUTS)
.plus(CUSTOM_VERSION)
- .map { CodeBlock.of("%N = %N", it, it) },
+ .map { CodeBlock.of("%1N = %1N", it) },
).build()
private fun Metadata.buildCommonConstructorParameters(
@@ -469,6 +544,7 @@ private fun Metadata.buildCommonConstructorParameters(
): List =
inputs
.flatMap { (key, input) ->
+ val propertyBaseName = key.toCamelCase()
val typedInput = inputTypings.containsKey(key)
val description = input.description.escapedForComments.removeTrailingWhitespacesForEachLine()
val kdocBuilder = CodeBlock.builder()
@@ -485,26 +561,54 @@ private fun Metadata.buildCommonConstructorParameters(
untypedClass.takeIf { !it && typedInput }?.let {
ParameterSpec
.builder(
- key.toCamelCase(),
- inputTypings.getInputType(
- key,
- input,
- coords,
- className,
- untypedClass = false,
- typedInput = true,
- ),
+ propertyBaseName,
+ inputTypings
+ .getInputType(key, coords, className)
+ .copy(nullable = true),
).defaultValue("null")
.addKdocIfNotEmpty(kdoc)
.build()
},
ParameterSpec
.builder(
- "${key.toCamelCase()}_Untyped",
- null.getInputType(key, input, coords, className, untypedClass, typedInput),
- ).defaultValueIfNullable(input, untypedClass, typedInput)
+ "${propertyBaseName}_Untyped",
+ null
+ .getInputType(key, coords, className)
+ .copy(nullable = true),
+ ).defaultValue("null")
.addKdocIfNotEmpty(kdoc)
.build(),
+ ParameterSpec
+ .builder(
+ "${propertyBaseName}Expression",
+ Expression
+ .parameterizedBy(inputTypings.getInputType(key, coords, className))
+ .copy(nullable = true),
+ ).defaultValue("null")
+ .addKdocIfNotEmpty(kdoc)
+ .build(),
+ (inputTypings[key] as? ListOfTypings)?.let { listOfTypings ->
+ ParameterSpec
+ .builder(
+ "${propertyBaseName}Expressions",
+ List::class
+ .asClassName()
+ .parameterizedBy(
+ Expression
+ .parameterizedBy(
+ listOfTypings
+ .typing
+ .getClassName(
+ actionPackageName = coords.owner.toKotlinPackageName(),
+ actionClassName = coords.buildActionClassName(),
+ fieldName = key,
+ ),
+ ),
+ ).copy(nullable = true),
+ ).defaultValue("null")
+ .addKdocIfNotEmpty(kdoc)
+ .build()
+ },
)
}.plus(
ParameterSpec
@@ -522,65 +626,80 @@ private fun Metadata.buildCommonConstructorParameters(
).build(),
)
-private fun ParameterSpec.Builder.defaultValueIfNullable(
- input: Input,
- untypedClass: Boolean,
- typedInput: Boolean,
-): ParameterSpec.Builder {
- if (input.shouldBeNullable(untypedClass, typedInput)) {
- defaultValue("null")
- }
- return this
-}
-
private fun TypeSpec.Builder.addInitializerBlockIfNecessary(
metadata: Metadata,
inputTypings: Map,
untypedClass: Boolean,
): TypeSpec.Builder {
- if (untypedClass || metadata.inputs.isEmpty() || metadata.inputs.none { inputTypings.containsKey(it.key) }) {
+ if (metadata.inputs.isEmpty()) {
return this
}
- addInitializerBlock(metadata.initializerBlock(inputTypings))
+ addInitializerBlock(metadata.initializerBlock(inputTypings, untypedClass))
return this
}
-private fun Metadata.initializerBlock(inputTypings: Map): CodeBlock {
+private fun Metadata.initializerBlock(
+ inputTypings: Map,
+ untypedClass: Boolean,
+): CodeBlock {
val codeBlockBuilder = CodeBlock.builder()
var first = true
- inputs
- .filter { inputTypings.containsKey(it.key) }
- .forEach { (key, input) ->
- if (!first) {
- codeBlockBuilder.add("\n")
- }
- first = false
- val propertyName = key.toCamelCase()
+ inputs.forEach { (key, input) ->
+ if (!first) {
+ codeBlockBuilder.add("\n")
+ }
+ first = false
+ val typedInput = inputTypings.containsKey(key)
+ val inputProperties =
+ listOfNotNull(
+ if (!untypedClass && typedInput) "%1N" else null,
+ "%1L_Untyped",
+ "%1LExpression",
+ if (inputTypings[key] is ListOfTypings) "%1LExpressions" else null,
+ )
+ val inputPropertyNames =
+ listOfNotNull(
+ if (!untypedClass && typedInput) "%1L" else null,
+ "%1L_Untyped",
+ "%1LExpression",
+ if (inputTypings[key] is ListOfTypings) "%1LExpressions" else null,
+ )
+ val propertyBaseName = key.toCamelCase()
+ codeBlockBuilder
+ .add(
+ """
+ require(listOfNotNull(${inputProperties.joinToString()}).size <= 1) {
+ %2S
+ }
+
+ """.trimIndent(),
+ propertyBaseName,
+ "Only one of ${
+ CodeBlock.of(
+ "${inputPropertyNames.dropLast(1).joinToString()}, and ${inputPropertyNames.last()}",
+ propertyBaseName,
+ )
+ } must be set, but not multiple",
+ )
+ if (input.shouldBeRequiredInBinding()) {
codeBlockBuilder
.add(
"""
- require(!((%1N != null) && (%1L_Untyped != null))) {
+ require(${inputProperties.joinToString(" || ") { "($it != null)" }}) {
%2S
}
""".trimIndent(),
- propertyName,
- "Only $propertyName or ${propertyName}_Untyped must be set, but not both",
+ propertyBaseName,
+ "Either ${
+ CodeBlock.of(
+ "${inputPropertyNames.dropLast(1).joinToString()}, or ${inputPropertyNames.last()}",
+ propertyBaseName,
+ )
+ } must be set, one of them is required",
)
- if (input.shouldBeRequiredInBinding()) {
- codeBlockBuilder
- .add(
- """
- require((%1N != null) || (%1L_Untyped != null)) {
- %2S
- }
-
- """.trimIndent(),
- propertyName,
- "Either $propertyName or ${propertyName}_Untyped must be set, one of them is required",
- )
- }
}
+ }
return codeBlockBuilder.build()
}
@@ -631,20 +750,10 @@ private fun Map?.getInputTyping(key: String) = this?.get(key) ?:
private fun Map?.getInputType(
key: String,
- input: Input,
coords: ActionCoords,
className: String,
- untypedClass: Boolean,
- typedInput: Boolean,
) = getInputTyping(key)
.getClassName(coords.owner.toKotlinPackageName(), className, key)
- .copy(nullable = input.shouldBeNullable(untypedClass, typedInput))
-
-private fun Input.shouldBeNullable(
- untypedClass: Boolean,
- typedInput: Boolean,
-) = (untypedClass && !shouldBeRequiredInBinding()) ||
- (!untypedClass && (typedInput || !shouldBeRequiredInBinding()))
private val String.escapedForComments
get() =
diff --git a/action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/typing/TypesProviding.kt b/action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/typing/TypesProviding.kt
index cf780d44c1..0a7e1b6f33 100644
--- a/action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/typing/TypesProviding.kt
+++ b/action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/typing/TypesProviding.kt
@@ -2,6 +2,7 @@ package io.github.typesafegithub.workflows.actionbindinggenerator.typing
import com.charleskorn.kaml.Yaml
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
+import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionTypings
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.CommitHash
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.MetadataRevision
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.NewestForVersion
@@ -21,12 +22,13 @@ import java.net.URI
internal fun ActionCoords.provideTypes(
metadataRevision: MetadataRevision,
fetchUri: (URI) -> String = ::fetchUri,
-): Pair, TypingActualSource?> =
+): ActionTypings =
(
this.fetchTypingMetadata(metadataRevision, fetchUri)
?: this.toMajorVersion().fetchFromTypingsFromCatalog(fetchUri)
- )?.let { Pair(it.first.toTypesMap(), it.second) }
- ?: Pair(emptyMap(), null)
+ )?.let { (typings, typingActualSource) ->
+ ActionTypings(typings.toInputTypesMap(), typings.toOutputTypesMap(), typingActualSource)
+ } ?: ActionTypings()
private fun ActionCoords.actionTypesYmlUrl(gitRef: String) =
"https://raw.githubusercontent.com/$owner/$repoName/$gitRef/$subName/action-types.yml"
@@ -108,11 +110,15 @@ private fun fetchTypingsFromUrl(
return myYaml.decodeFromStringOrDefaultIfEmpty(typesMetadataYml, ActionTypes())
}
-internal fun ActionTypes.toTypesMap(): Map =
- inputs.mapValues { (key, value) ->
+private fun Map.toTypesMap(): Map =
+ mapValues { (key, value) ->
value.toTyping(key)
}
+private fun ActionTypes.toInputTypesMap(): Map = inputs.toTypesMap()
+
+private fun ActionTypes.toOutputTypesMap(): Map = outputs.toTypesMap()
+
private fun ActionCoords.toMajorVersion(): ActionCoords = this.copy(version = this.version.substringBefore("."))
private fun ActionType.toTyping(fieldName: String): Typing =
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithAllTypesOfInputs.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithAllTypesOfInputs.kt
index cde8bf55ed..2a728b634f 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithAllTypesOfInputs.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithAllTypesOfInputs.kt
@@ -4,15 +4,19 @@
@file:Suppress(
"DataClassPrivateConstructor",
"UNUSED_PARAMETER",
+ "DEPRECATION",
)
package io.github.typesafegithub.workflows.actions.johnsmith
+import io.github.typesafegithub.workflows.domain.Expression
import io.github.typesafegithub.workflows.domain.actions.Action
import io.github.typesafegithub.workflows.domain.actions.RegularAction
import java.util.LinkedHashMap
+import kotlin.Any
import kotlin.Boolean
import kotlin.ConsistentCopyVisibility
+import kotlin.Deprecated
import kotlin.Float
import kotlin.Int
import kotlin.String
@@ -32,28 +36,44 @@ import kotlin.collections.toTypedArray
*
* @param fooBar <required> Short description
* @param fooBar_Untyped <required> Short description
+ * @param fooBarExpression <required> Short description
* @param bazGoo <required> First boolean input!
* @param bazGoo_Untyped <required> First boolean input!
+ * @param bazGooExpression <required> First boolean input!
* @param binKin Boolean and nullable
* @param binKin_Untyped Boolean and nullable
+ * @param binKinExpression Boolean and nullable
* @param intPint <required> Integer
* @param intPint_Untyped <required> Integer
+ * @param intPintExpression <required> Integer
* @param floPint <required> Float
* @param floPint_Untyped <required> Float
+ * @param floPintExpression <required> Float
* @param finBin <required> Enumeration
* @param finBin_Untyped <required> Enumeration
+ * @param finBinExpression <required> Enumeration
* @param gooZen <required> Integer with special value
* @param gooZen_Untyped <required> Integer with special value
+ * @param gooZenExpression <required> Integer with special value
* @param bahEnum <required> Enum with custom naming
* @param bahEnum_Untyped <required> Enum with custom naming
+ * @param bahEnumExpression <required> Enum with custom naming
* @param listStrings List of strings
* @param listStrings_Untyped List of strings
+ * @param listStringsExpression List of strings
+ * @param listStringsExpressions List of strings
* @param listInts List of integers
* @param listInts_Untyped List of integers
+ * @param listIntsExpression List of integers
+ * @param listIntsExpressions List of integers
* @param listEnums List of enums
* @param listEnums_Untyped List of enums
+ * @param listEnumsExpression List of enums
+ * @param listEnumsExpressions List of enums
* @param listIntSpecial List of integer with special values
* @param listIntSpecial_Untyped List of integer with special values
+ * @param listIntSpecialExpression List of integer with special values
+ * @param listIntSpecialExpressions List of integer with special values
* @param _customInputs Type-unsafe map where you can put any inputs that are not yet supported by
* the binding
* @param _customVersion Allows overriding action's version, for example to use a specific minor
@@ -68,7 +88,12 @@ public data class ActionWithAllTypesOfInputs private constructor(
/**
* <required> Short description
*/
+ @Deprecated("Use the typed property or expression property instead")
public val fooBar_Untyped: String? = null,
+ /**
+ * <required> Short description
+ */
+ public val fooBarExpression: Expression? = null,
/**
* <required> First boolean input!
*/
@@ -76,7 +101,12 @@ public data class ActionWithAllTypesOfInputs private constructor(
/**
* <required> First boolean input!
*/
+ @Deprecated("Use the typed property or expression property instead")
public val bazGoo_Untyped: String? = null,
+ /**
+ * <required> First boolean input!
+ */
+ public val bazGooExpression: Expression? = null,
/**
* Boolean and nullable
*/
@@ -84,7 +114,12 @@ public data class ActionWithAllTypesOfInputs private constructor(
/**
* Boolean and nullable
*/
+ @Deprecated("Use the typed property or expression property instead")
public val binKin_Untyped: String? = null,
+ /**
+ * Boolean and nullable
+ */
+ public val binKinExpression: Expression? = null,
/**
* <required> Integer
*/
@@ -92,7 +127,12 @@ public data class ActionWithAllTypesOfInputs private constructor(
/**
* <required> Integer
*/
+ @Deprecated("Use the typed property or expression property instead")
public val intPint_Untyped: String? = null,
+ /**
+ * <required> Integer
+ */
+ public val intPintExpression: Expression? = null,
/**
* <required> Float
*/
@@ -100,7 +140,12 @@ public data class ActionWithAllTypesOfInputs private constructor(
/**
* <required> Float
*/
+ @Deprecated("Use the typed property or expression property instead")
public val floPint_Untyped: String? = null,
+ /**
+ * <required> Float
+ */
+ public val floPintExpression: Expression? = null,
/**
* <required> Enumeration
*/
@@ -108,7 +153,12 @@ public data class ActionWithAllTypesOfInputs private constructor(
/**
* <required> Enumeration
*/
+ @Deprecated("Use the typed property or expression property instead")
public val finBin_Untyped: String? = null,
+ /**
+ * <required> Enumeration
+ */
+ public val finBinExpression: Expression? = null,
/**
* <required> Integer with special value
*/
@@ -116,7 +166,12 @@ public data class ActionWithAllTypesOfInputs private constructor(
/**
* <required> Integer with special value
*/
+ @Deprecated("Use the typed property or expression property instead")
public val gooZen_Untyped: String? = null,
+ /**
+ * <required> Integer with special value
+ */
+ public val gooZenExpression: Expression? = null,
/**
* <required> Enum with custom naming
*/
@@ -124,7 +179,12 @@ public data class ActionWithAllTypesOfInputs private constructor(
/**
* <required> Enum with custom naming
*/
+ @Deprecated("Use the typed property or expression property instead")
public val bahEnum_Untyped: String? = null,
+ /**
+ * <required> Enum with custom naming
+ */
+ public val bahEnumExpression: Expression? = null,
/**
* List of strings
*/
@@ -132,7 +192,16 @@ public data class ActionWithAllTypesOfInputs private constructor(
/**
* List of strings
*/
+ @Deprecated("Use the typed property or expression property instead")
public val listStrings_Untyped: String? = null,
+ /**
+ * List of strings
+ */
+ public val listStringsExpression: Expression>? = null,
+ /**
+ * List of strings
+ */
+ public val listStringsExpressions: List>? = null,
/**
* List of integers
*/
@@ -140,7 +209,16 @@ public data class ActionWithAllTypesOfInputs private constructor(
/**
* List of integers
*/
+ @Deprecated("Use the typed property or expression property instead")
public val listInts_Untyped: String? = null,
+ /**
+ * List of integers
+ */
+ public val listIntsExpression: Expression>? = null,
+ /**
+ * List of integers
+ */
+ public val listIntsExpressions: List>? = null,
/**
* List of enums
*/
@@ -148,7 +226,16 @@ public data class ActionWithAllTypesOfInputs private constructor(
/**
* List of enums
*/
+ @Deprecated("Use the typed property or expression property instead")
public val listEnums_Untyped: String? = null,
+ /**
+ * List of enums
+ */
+ public val listEnumsExpression: Expression>? = null,
+ /**
+ * List of enums
+ */
+ public val listEnumsExpressions: List>? = null,
/**
* List of integer with special values
*/
@@ -156,7 +243,17 @@ public data class ActionWithAllTypesOfInputs private constructor(
/**
* List of integer with special values
*/
+ @Deprecated("Use the typed property or expression property instead")
public val listIntSpecial_Untyped: String? = null,
+ /**
+ * List of integer with special values
+ */
+ public val listIntSpecialExpression: Expression>? = null,
+ /**
+ * List of integer with special values
+ */
+ public val listIntSpecialExpressions: List>? =
+ null,
/**
* Type-unsafe map where you can put any inputs that are not yet supported by the binding
*/
@@ -169,73 +266,91 @@ public data class ActionWithAllTypesOfInputs private constructor(
) : RegularAction("john-smith",
"action-with-all-types-of-inputs", _customVersion ?: "v3") {
init {
- require(!((fooBar != null) && (fooBar_Untyped != null))) {
- "Only fooBar or fooBar_Untyped must be set, but not both"
+ require(listOfNotNull(fooBar, fooBar_Untyped, fooBarExpression).size <= 1) {
+ "Only one of fooBar, fooBar_Untyped, and fooBarExpression must be set, but not multiple"
}
- require((fooBar != null) || (fooBar_Untyped != null)) {
- "Either fooBar or fooBar_Untyped must be set, one of them is required"
+ require((fooBar != null) || (fooBar_Untyped != null) || (fooBarExpression != null)) {
+
+ "Either fooBar, fooBar_Untyped, or fooBarExpression must be set, one of them is required"
}
- require(!((bazGoo != null) && (bazGoo_Untyped != null))) {
- "Only bazGoo or bazGoo_Untyped must be set, but not both"
+ require(listOfNotNull(bazGoo, bazGoo_Untyped, bazGooExpression).size <= 1) {
+ "Only one of bazGoo, bazGoo_Untyped, and bazGooExpression must be set, but not multiple"
}
- require((bazGoo != null) || (bazGoo_Untyped != null)) {
- "Either bazGoo or bazGoo_Untyped must be set, one of them is required"
+ require((bazGoo != null) || (bazGoo_Untyped != null) || (bazGooExpression != null)) {
+
+ "Either bazGoo, bazGoo_Untyped, or bazGooExpression must be set, one of them is required"
}
- require(!((binKin != null) && (binKin_Untyped != null))) {
- "Only binKin or binKin_Untyped must be set, but not both"
+ require(listOfNotNull(binKin, binKin_Untyped, binKinExpression).size <= 1) {
+ "Only one of binKin, binKin_Untyped, and binKinExpression must be set, but not multiple"
}
- require(!((intPint != null) && (intPint_Untyped != null))) {
- "Only intPint or intPint_Untyped must be set, but not both"
+ require(listOfNotNull(intPint, intPint_Untyped, intPintExpression).size <= 1) {
+
+ "Only one of intPint, intPint_Untyped, and intPintExpression must be set, but not multiple"
}
- require((intPint != null) || (intPint_Untyped != null)) {
- "Either intPint or intPint_Untyped must be set, one of them is required"
+ require((intPint != null) || (intPint_Untyped != null) || (intPintExpression != null)) {
+
+ "Either intPint, intPint_Untyped, or intPintExpression must be set, one of them is required"
}
- require(!((floPint != null) && (floPint_Untyped != null))) {
- "Only floPint or floPint_Untyped must be set, but not both"
+ require(listOfNotNull(floPint, floPint_Untyped, floPintExpression).size <= 1) {
+
+ "Only one of floPint, floPint_Untyped, and floPintExpression must be set, but not multiple"
}
- require((floPint != null) || (floPint_Untyped != null)) {
- "Either floPint or floPint_Untyped must be set, one of them is required"
+ require((floPint != null) || (floPint_Untyped != null) || (floPintExpression != null)) {
+
+ "Either floPint, floPint_Untyped, or floPintExpression must be set, one of them is required"
}
- require(!((finBin != null) && (finBin_Untyped != null))) {
- "Only finBin or finBin_Untyped must be set, but not both"
+ require(listOfNotNull(finBin, finBin_Untyped, finBinExpression).size <= 1) {
+ "Only one of finBin, finBin_Untyped, and finBinExpression must be set, but not multiple"
}
- require((finBin != null) || (finBin_Untyped != null)) {
- "Either finBin or finBin_Untyped must be set, one of them is required"
+ require((finBin != null) || (finBin_Untyped != null) || (finBinExpression != null)) {
+
+ "Either finBin, finBin_Untyped, or finBinExpression must be set, one of them is required"
}
- require(!((gooZen != null) && (gooZen_Untyped != null))) {
- "Only gooZen or gooZen_Untyped must be set, but not both"
+ require(listOfNotNull(gooZen, gooZen_Untyped, gooZenExpression).size <= 1) {
+ "Only one of gooZen, gooZen_Untyped, and gooZenExpression must be set, but not multiple"
}
- require((gooZen != null) || (gooZen_Untyped != null)) {
- "Either gooZen or gooZen_Untyped must be set, one of them is required"
+ require((gooZen != null) || (gooZen_Untyped != null) || (gooZenExpression != null)) {
+
+ "Either gooZen, gooZen_Untyped, or gooZenExpression must be set, one of them is required"
}
- require(!((bahEnum != null) && (bahEnum_Untyped != null))) {
- "Only bahEnum or bahEnum_Untyped must be set, but not both"
+ require(listOfNotNull(bahEnum, bahEnum_Untyped, bahEnumExpression).size <= 1) {
+
+ "Only one of bahEnum, bahEnum_Untyped, and bahEnumExpression must be set, but not multiple"
}
- require((bahEnum != null) || (bahEnum_Untyped != null)) {
- "Either bahEnum or bahEnum_Untyped must be set, one of them is required"
+ require((bahEnum != null) || (bahEnum_Untyped != null) || (bahEnumExpression != null)) {
+
+ "Either bahEnum, bahEnum_Untyped, or bahEnumExpression must be set, one of them is required"
}
- require(!((listStrings != null) && (listStrings_Untyped != null))) {
- "Only listStrings or listStrings_Untyped must be set, but not both"
+ require(listOfNotNull(listStrings, listStrings_Untyped, listStringsExpression,
+ listStringsExpressions).size <= 1) {
+
+ "Only one of listStrings, listStrings_Untyped, listStringsExpression, and listStringsExpressions must be set, but not multiple"
}
- require(!((listInts != null) && (listInts_Untyped != null))) {
- "Only listInts or listInts_Untyped must be set, but not both"
+ require(listOfNotNull(listInts, listInts_Untyped, listIntsExpression,
+ listIntsExpressions).size <= 1) {
+
+ "Only one of listInts, listInts_Untyped, listIntsExpression, and listIntsExpressions must be set, but not multiple"
}
- require(!((listEnums != null) && (listEnums_Untyped != null))) {
- "Only listEnums or listEnums_Untyped must be set, but not both"
+ require(listOfNotNull(listEnums, listEnums_Untyped, listEnumsExpression,
+ listEnumsExpressions).size <= 1) {
+
+ "Only one of listEnums, listEnums_Untyped, listEnumsExpression, and listEnumsExpressions must be set, but not multiple"
}
- require(!((listIntSpecial != null) && (listIntSpecial_Untyped != null))) {
- "Only listIntSpecial or listIntSpecial_Untyped must be set, but not both"
+ require(listOfNotNull(listIntSpecial, listIntSpecial_Untyped, listIntSpecialExpression,
+ listIntSpecialExpressions).size <= 1) {
+
+ "Only one of listIntSpecial, listIntSpecial_Untyped, listIntSpecialExpression, and listIntSpecialExpressions must be set, but not multiple"
}
}
@@ -243,68 +358,113 @@ public data class ActionWithAllTypesOfInputs private constructor(
vararg pleaseUseNamedArguments: Unit,
fooBar: String? = null,
fooBar_Untyped: String? = null,
+ fooBarExpression: Expression? = null,
bazGoo: Boolean? = null,
bazGoo_Untyped: String? = null,
+ bazGooExpression: Expression? = null,
binKin: Boolean? = null,
binKin_Untyped: String? = null,
+ binKinExpression: Expression? = null,
intPint: Int? = null,
intPint_Untyped: String? = null,
+ intPintExpression: Expression? = null,
floPint: Float? = null,
floPint_Untyped: String? = null,
+ floPintExpression: Expression? = null,
finBin: ActionWithAllTypesOfInputs.Bin? = null,
finBin_Untyped: String? = null,
+ finBinExpression: Expression? = null,
gooZen: ActionWithAllTypesOfInputs.Zen? = null,
gooZen_Untyped: String? = null,
+ gooZenExpression: Expression? = null,
bahEnum: ActionWithAllTypesOfInputs.BahEnum? = null,
bahEnum_Untyped: String? = null,
+ bahEnumExpression: Expression? = null,
listStrings: List? = null,
listStrings_Untyped: String? = null,
+ listStringsExpression: Expression>? = null,
+ listStringsExpressions: List>? = null,
listInts: List? = null,
listInts_Untyped: String? = null,
+ listIntsExpression: Expression>? = null,
+ listIntsExpressions: List>? = null,
listEnums: List? = null,
listEnums_Untyped: String? = null,
+ listEnumsExpression: Expression>? = null,
+ listEnumsExpressions: List>? = null,
listIntSpecial: List? = null,
listIntSpecial_Untyped: String? = null,
+ listIntSpecialExpression: Expression>? = null,
+ listIntSpecialExpressions: List>? = null,
_customInputs: Map = mapOf(),
_customVersion: String? = null,
- ) : this(fooBar = fooBar, fooBar_Untyped = fooBar_Untyped, bazGoo = bazGoo, bazGoo_Untyped =
- bazGoo_Untyped, binKin = binKin, binKin_Untyped = binKin_Untyped, intPint = intPint,
- intPint_Untyped = intPint_Untyped, floPint = floPint, floPint_Untyped = floPint_Untyped,
- finBin = finBin, finBin_Untyped = finBin_Untyped, gooZen = gooZen, gooZen_Untyped =
- gooZen_Untyped, bahEnum = bahEnum, bahEnum_Untyped = bahEnum_Untyped, listStrings =
- listStrings, listStrings_Untyped = listStrings_Untyped, listInts = listInts,
- listInts_Untyped = listInts_Untyped, listEnums = listEnums, listEnums_Untyped =
- listEnums_Untyped, listIntSpecial = listIntSpecial, listIntSpecial_Untyped =
- listIntSpecial_Untyped, _customInputs = _customInputs, _customVersion = _customVersion)
+ ) : this(fooBar = fooBar, fooBar_Untyped = fooBar_Untyped, fooBarExpression = fooBarExpression,
+ bazGoo = bazGoo, bazGoo_Untyped = bazGoo_Untyped, bazGooExpression = bazGooExpression,
+ binKin = binKin, binKin_Untyped = binKin_Untyped, binKinExpression = binKinExpression,
+ intPint = intPint, intPint_Untyped = intPint_Untyped, intPintExpression =
+ intPintExpression, floPint = floPint, floPint_Untyped = floPint_Untyped,
+ floPintExpression = floPintExpression, finBin = finBin, finBin_Untyped = finBin_Untyped,
+ finBinExpression = finBinExpression, gooZen = gooZen, gooZen_Untyped = gooZen_Untyped,
+ gooZenExpression = gooZenExpression, bahEnum = bahEnum, bahEnum_Untyped =
+ bahEnum_Untyped, bahEnumExpression = bahEnumExpression, listStrings = listStrings,
+ listStrings_Untyped = listStrings_Untyped, listStringsExpression =
+ listStringsExpression, listStringsExpressions = listStringsExpressions, listInts =
+ listInts, listInts_Untyped = listInts_Untyped, listIntsExpression = listIntsExpression,
+ listIntsExpressions = listIntsExpressions, listEnums = listEnums, listEnums_Untyped =
+ listEnums_Untyped, listEnumsExpression = listEnumsExpression, listEnumsExpressions =
+ listEnumsExpressions, listIntSpecial = listIntSpecial, listIntSpecial_Untyped =
+ listIntSpecial_Untyped, listIntSpecialExpression = listIntSpecialExpression,
+ listIntSpecialExpressions = listIntSpecialExpressions, _customInputs = _customInputs,
+ _customVersion = _customVersion)
@Suppress("SpreadOperator")
override fun toYamlArguments(): LinkedHashMap = linkedMapOf(
*listOfNotNull(
fooBar?.let { "foo-bar" to it },
fooBar_Untyped?.let { "foo-bar" to it },
+ fooBarExpression?.let { "foo-bar" to it.expressionString },
bazGoo?.let { "baz-goo" to it.toString() },
bazGoo_Untyped?.let { "baz-goo" to it },
+ bazGooExpression?.let { "baz-goo" to it.expressionString },
binKin?.let { "bin-kin" to it.toString() },
binKin_Untyped?.let { "bin-kin" to it },
+ binKinExpression?.let { "bin-kin" to it.expressionString },
intPint?.let { "int-pint" to it.toString() },
intPint_Untyped?.let { "int-pint" to it },
+ intPintExpression?.let { "int-pint" to it.expressionString },
floPint?.let { "flo-pint" to it.toString() },
floPint_Untyped?.let { "flo-pint" to it },
+ floPintExpression?.let { "flo-pint" to it.expressionString },
finBin?.let { "fin-bin" to it.stringValue },
finBin_Untyped?.let { "fin-bin" to it },
+ finBinExpression?.let { "fin-bin" to it.expressionString },
gooZen?.let { "goo-zen" to it.integerValue.toString() },
gooZen_Untyped?.let { "goo-zen" to it },
+ gooZenExpression?.let { "goo-zen" to it.expressionString },
bahEnum?.let { "bah-enum" to it.stringValue },
bahEnum_Untyped?.let { "bah-enum" to it },
+ bahEnumExpression?.let { "bah-enum" to it.expressionString },
listStrings?.let { "list-strings" to it.joinToString(",") },
listStrings_Untyped?.let { "list-strings" to it },
+ listStringsExpression?.let { "list-strings" to it.expressionString },
+ listStringsExpressions?.let { "list-strings" to it.joinToString(" ", transform =
+ Expression<*>::expressionString) },
listInts?.let { "list-ints" to it.joinToString(",") { it.toString() } },
listInts_Untyped?.let { "list-ints" to it },
+ listIntsExpression?.let { "list-ints" to it.expressionString },
+ listIntsExpressions?.let { "list-ints" to it.joinToString(" ", transform =
+ Expression<*>::expressionString) },
listEnums?.let { "list-enums" to it.joinToString(",") { it.stringValue } },
listEnums_Untyped?.let { "list-enums" to it },
+ listEnumsExpression?.let { "list-enums" to it.expressionString },
+ listEnumsExpressions?.let { "list-enums" to it.joinToString(" ", transform =
+ Expression<*>::expressionString) },
listIntSpecial?.let { "list-int-special" to it.joinToString(",") {
it.integerValue.toString() } },
listIntSpecial_Untyped?.let { "list-int-special" to it },
+ listIntSpecialExpression?.let { "list-int-special" to it.expressionString },
+ listIntSpecialExpressions?.let { "list-int-special" to it.joinToString(" ", transform =
+ Expression<*>::expressionString) },
*_customInputs.toList().toTypedArray(),
).toTypedArray()
)
@@ -375,8 +535,132 @@ public data class ActionWithAllTypesOfInputs private constructor(
stepId: String,
) : Action.Outputs(stepId) {
/**
- * Cool output!
+ * Short description output
+ */
+ public val fooBar: Expression = Expression("steps.$stepId.outputs.foo-bar")
+
+ /**
+ * Short description output
+ */
+ public val fooBar_Untyped: Expression = Expression("steps.$stepId.outputs.foo-bar")
+
+ /**
+ * First boolean input! output
+ */
+ public val bazGoo: Expression = Expression("steps.$stepId.outputs.baz-goo")
+
+ /**
+ * First boolean input! output
+ */
+ public val bazGoo_Untyped: Expression = Expression("steps.$stepId.outputs.baz-goo")
+
+ /**
+ * Boolean and nullable output
+ */
+ public val binKin: Expression = Expression("steps.$stepId.outputs.bin-kin")
+
+ /**
+ * Boolean and nullable output
+ */
+ public val binKin_Untyped: Expression = Expression("steps.$stepId.outputs.bin-kin")
+
+ /**
+ * Integer output
+ */
+ public val intPint: Expression = Expression("steps.$stepId.outputs.int-pint")
+
+ /**
+ * Integer output
+ */
+ public val intPint_Untyped: Expression = Expression("steps.$stepId.outputs.int-pint")
+
+ /**
+ * Float output
+ */
+ public val floPint: Expression = Expression("steps.$stepId.outputs.flo-pint")
+
+ /**
+ * Float output
+ */
+ public val floPint_Untyped: Expression = Expression("steps.$stepId.outputs.flo-pint")
+
+ /**
+ * Enumeration output
+ */
+ public val finBin: Expression =
+ Expression("steps.$stepId.outputs.fin-bin")
+
+ /**
+ * Enumeration output
+ */
+ public val finBin_Untyped: Expression = Expression("steps.$stepId.outputs.fin-bin")
+
+ /**
+ * Integer with special value output
+ */
+ public val gooZen: Expression =
+ Expression("steps.$stepId.outputs.goo-zen")
+
+ /**
+ * Integer with special value output
+ */
+ public val gooZen_Untyped: Expression = Expression("steps.$stepId.outputs.goo-zen")
+
+ /**
+ * Enum with custom naming output
+ */
+ public val bahEnum: Expression =
+ Expression("steps.$stepId.outputs.bah-enum")
+
+ /**
+ * Enum with custom naming output
+ */
+ public val bahEnum_Untyped: Expression = Expression("steps.$stepId.outputs.bah-enum")
+
+ /**
+ * List of strings output
+ */
+ public val listStrings: Expression> =
+ Expression("steps.$stepId.outputs.list-strings")
+
+ /**
+ * List of strings output
+ */
+ public val listStrings_Untyped: Expression =
+ Expression("steps.$stepId.outputs.list-strings")
+
+ /**
+ * List of integers output
+ */
+ public val listInts: Expression> = Expression("steps.$stepId.outputs.list-ints")
+
+ /**
+ * List of integers output
+ */
+ public val listInts_Untyped: Expression = Expression("steps.$stepId.outputs.list-ints")
+
+ /**
+ * List of enums output
+ */
+ public val listEnums: Expression> =
+ Expression("steps.$stepId.outputs.list-enums")
+
+ /**
+ * List of enums output
+ */
+ public val listEnums_Untyped: Expression =
+ Expression("steps.$stepId.outputs.list-enums")
+
+ /**
+ * List of integer with special values output
+ */
+ public val listIntSpecial: Expression> =
+ Expression("steps.$stepId.outputs.list-int-special")
+
+ /**
+ * List of integer with special values output
*/
- public val bazGoo: String = "steps.$stepId.outputs.baz-goo"
+ public val listIntSpecial_Untyped: Expression =
+ Expression("steps.$stepId.outputs.list-int-special")
}
}
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithAllTypesOfInputsTest.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithAllTypesOfInputsTest.kt
index e784add0b5..92c9a8efd6 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithAllTypesOfInputsTest.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithAllTypesOfInputsTest.kt
@@ -107,7 +107,7 @@ class ActionWithAllTypesOfInputsTest : DescribeSpec({
shouldThrow {
ActionWithAllTypesOfInputs()
}
- exception.message shouldBe "Either fooBar or fooBar_Untyped must be set, one of them is required"
+ exception.message shouldBe "Either fooBar, fooBar_Untyped, or fooBarExpression must be set, one of them is required"
}
it("validates required inputs are not supplied typed and untyped") {
@@ -119,7 +119,7 @@ class ActionWithAllTypesOfInputsTest : DescribeSpec({
fooBar_Untyped = "untyped test",
)
}
- exception.message shouldBe "Only fooBar or fooBar_Untyped must be set, but not both"
+ exception.message shouldBe "Only one of fooBar, fooBar_Untyped, and fooBarExpression must be set, but not multiple"
}
it("validates not-required inputs are not supplied typed and untyped") {
@@ -139,6 +139,6 @@ class ActionWithAllTypesOfInputsTest : DescribeSpec({
listStrings_Untyped = "untyped test",
)
}
- exception.message shouldBe "Only listStrings or listStrings_Untyped must be set, but not both"
+ exception.message shouldBe "Only one of listStrings, listStrings_Untyped, listStringsExpression, and listStringsExpressions must be set, but not multiple"
}
})
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithAllTypesOfInputs_Untyped.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithAllTypesOfInputs_Untyped.kt
index 6033d28aef..20e4bb42ea 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithAllTypesOfInputs_Untyped.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithAllTypesOfInputs_Untyped.kt
@@ -4,13 +4,16 @@
@file:Suppress(
"DataClassPrivateConstructor",
"UNUSED_PARAMETER",
+ "DEPRECATION",
)
package io.github.typesafegithub.workflows.actions.johnsmith
+import io.github.typesafegithub.workflows.domain.Expression
import io.github.typesafegithub.workflows.domain.actions.Action
import io.github.typesafegithub.workflows.domain.actions.RegularAction
import java.util.LinkedHashMap
+import kotlin.Any
import kotlin.ConsistentCopyVisibility
import kotlin.Deprecated
import kotlin.String
@@ -48,17 +51,29 @@ import kotlin.collections.toTypedArray
* [Action on GitHub](https://github.com/john-smith/action-with-all-types-of-inputs)
*
* @param fooBar_Untyped Short description
+ * @param fooBarExpression Short description
* @param bazGoo_Untyped First boolean input!
+ * @param bazGooExpression First boolean input!
* @param binKin_Untyped Boolean and nullable
+ * @param binKinExpression Boolean and nullable
* @param intPint_Untyped Integer
+ * @param intPintExpression Integer
* @param floPint_Untyped Float
+ * @param floPintExpression Float
* @param finBin_Untyped Enumeration
+ * @param finBinExpression Enumeration
* @param gooZen_Untyped Integer with special value
+ * @param gooZenExpression Integer with special value
* @param bahEnum_Untyped Enum with custom naming
+ * @param bahEnumExpression Enum with custom naming
* @param listStrings_Untyped List of strings
+ * @param listStringsExpression List of strings
* @param listInts_Untyped List of integers
+ * @param listIntsExpression List of integers
* @param listEnums_Untyped List of enums
+ * @param listEnumsExpression List of enums
* @param listIntSpecial_Untyped List of integer with special values
+ * @param listIntSpecialExpression List of integer with special values
* @param _customInputs Type-unsafe map where you can put any inputs that are not yet supported by
* the binding
* @param _customVersion Allows overriding action's version, for example to use a specific minor
@@ -73,51 +88,99 @@ public data class ActionWithAllTypesOfInputs_Untyped private constructor(
/**
* Short description
*/
- public val fooBar_Untyped: String,
+ public val fooBar_Untyped: String? = null,
+ /**
+ * Short description
+ */
+ public val fooBarExpression: Expression? = null,
+ /**
+ * First boolean input!
+ */
+ public val bazGoo_Untyped: String? = null,
/**
* First boolean input!
*/
- public val bazGoo_Untyped: String,
+ public val bazGooExpression: Expression? = null,
/**
* Boolean and nullable
*/
public val binKin_Untyped: String? = null,
+ /**
+ * Boolean and nullable
+ */
+ public val binKinExpression: Expression? = null,
/**
* Integer
*/
- public val intPint_Untyped: String,
+ public val intPint_Untyped: String? = null,
+ /**
+ * Integer
+ */
+ public val intPintExpression: Expression? = null,
/**
* Float
*/
- public val floPint_Untyped: String,
+ public val floPint_Untyped: String? = null,
+ /**
+ * Float
+ */
+ public val floPintExpression: Expression? = null,
+ /**
+ * Enumeration
+ */
+ public val finBin_Untyped: String? = null,
/**
* Enumeration
*/
- public val finBin_Untyped: String,
+ public val finBinExpression: Expression? = null,
+ /**
+ * Integer with special value
+ */
+ public val gooZen_Untyped: String? = null,
/**
* Integer with special value
*/
- public val gooZen_Untyped: String,
+ public val gooZenExpression: Expression? = null,
/**
* Enum with custom naming
*/
- public val bahEnum_Untyped: String,
+ public val bahEnum_Untyped: String? = null,
+ /**
+ * Enum with custom naming
+ */
+ public val bahEnumExpression: Expression? = null,
/**
* List of strings
*/
public val listStrings_Untyped: String? = null,
+ /**
+ * List of strings
+ */
+ public val listStringsExpression: Expression? = null,
/**
* List of integers
*/
public val listInts_Untyped: String? = null,
+ /**
+ * List of integers
+ */
+ public val listIntsExpression: Expression? = null,
/**
* List of enums
*/
public val listEnums_Untyped: String? = null,
+ /**
+ * List of enums
+ */
+ public val listEnumsExpression: Expression? = null,
/**
* List of integer with special values
*/
public val listIntSpecial_Untyped: String? = null,
+ /**
+ * List of integer with special values
+ */
+ public val listIntSpecialExpression: Expression? = null,
/**
* Type-unsafe map where you can put any inputs that are not yet supported by the binding
*/
@@ -129,44 +192,148 @@ public data class ActionWithAllTypesOfInputs_Untyped private constructor(
public val _customVersion: String? = null,
) : RegularAction("john-smith",
"action-with-all-types-of-inputs", _customVersion ?: "v3") {
+ init {
+ require(listOfNotNull(fooBar_Untyped, fooBarExpression).size <= 1) {
+ "Only one of fooBar_Untyped, and fooBarExpression must be set, but not multiple"
+ }
+ require((fooBar_Untyped != null) || (fooBarExpression != null)) {
+ "Either fooBar_Untyped, or fooBarExpression must be set, one of them is required"
+ }
+
+ require(listOfNotNull(bazGoo_Untyped, bazGooExpression).size <= 1) {
+ "Only one of bazGoo_Untyped, and bazGooExpression must be set, but not multiple"
+ }
+ require((bazGoo_Untyped != null) || (bazGooExpression != null)) {
+ "Either bazGoo_Untyped, or bazGooExpression must be set, one of them is required"
+ }
+
+ require(listOfNotNull(binKin_Untyped, binKinExpression).size <= 1) {
+ "Only one of binKin_Untyped, and binKinExpression must be set, but not multiple"
+ }
+
+ require(listOfNotNull(intPint_Untyped, intPintExpression).size <= 1) {
+ "Only one of intPint_Untyped, and intPintExpression must be set, but not multiple"
+ }
+ require((intPint_Untyped != null) || (intPintExpression != null)) {
+ "Either intPint_Untyped, or intPintExpression must be set, one of them is required"
+ }
+
+ require(listOfNotNull(floPint_Untyped, floPintExpression).size <= 1) {
+ "Only one of floPint_Untyped, and floPintExpression must be set, but not multiple"
+ }
+ require((floPint_Untyped != null) || (floPintExpression != null)) {
+ "Either floPint_Untyped, or floPintExpression must be set, one of them is required"
+ }
+
+ require(listOfNotNull(finBin_Untyped, finBinExpression).size <= 1) {
+ "Only one of finBin_Untyped, and finBinExpression must be set, but not multiple"
+ }
+ require((finBin_Untyped != null) || (finBinExpression != null)) {
+ "Either finBin_Untyped, or finBinExpression must be set, one of them is required"
+ }
+
+ require(listOfNotNull(gooZen_Untyped, gooZenExpression).size <= 1) {
+ "Only one of gooZen_Untyped, and gooZenExpression must be set, but not multiple"
+ }
+ require((gooZen_Untyped != null) || (gooZenExpression != null)) {
+ "Either gooZen_Untyped, or gooZenExpression must be set, one of them is required"
+ }
+
+ require(listOfNotNull(bahEnum_Untyped, bahEnumExpression).size <= 1) {
+ "Only one of bahEnum_Untyped, and bahEnumExpression must be set, but not multiple"
+ }
+ require((bahEnum_Untyped != null) || (bahEnumExpression != null)) {
+ "Either bahEnum_Untyped, or bahEnumExpression must be set, one of them is required"
+ }
+
+ require(listOfNotNull(listStrings_Untyped, listStringsExpression).size <= 1) {
+
+ "Only one of listStrings_Untyped, and listStringsExpression must be set, but not multiple"
+ }
+
+ require(listOfNotNull(listInts_Untyped, listIntsExpression).size <= 1) {
+ "Only one of listInts_Untyped, and listIntsExpression must be set, but not multiple"
+ }
+
+ require(listOfNotNull(listEnums_Untyped, listEnumsExpression).size <= 1) {
+ "Only one of listEnums_Untyped, and listEnumsExpression must be set, but not multiple"
+ }
+
+ require(listOfNotNull(listIntSpecial_Untyped, listIntSpecialExpression).size <= 1) {
+
+ "Only one of listIntSpecial_Untyped, and listIntSpecialExpression must be set, but not multiple"
+ }
+ }
+
public constructor(
vararg pleaseUseNamedArguments: Unit,
- fooBar_Untyped: String,
- bazGoo_Untyped: String,
+ fooBar_Untyped: String? = null,
+ fooBarExpression: Expression? = null,
+ bazGoo_Untyped: String? = null,
+ bazGooExpression: Expression? = null,
binKin_Untyped: String? = null,
- intPint_Untyped: String,
- floPint_Untyped: String,
- finBin_Untyped: String,
- gooZen_Untyped: String,
- bahEnum_Untyped: String,
+ binKinExpression: Expression? = null,
+ intPint_Untyped: String? = null,
+ intPintExpression: Expression? = null,
+ floPint_Untyped: String? = null,
+ floPintExpression: Expression? = null,
+ finBin_Untyped: String? = null,
+ finBinExpression: Expression? = null,
+ gooZen_Untyped: String? = null,
+ gooZenExpression: Expression? = null,
+ bahEnum_Untyped: String? = null,
+ bahEnumExpression: Expression? = null,
listStrings_Untyped: String? = null,
+ listStringsExpression: Expression? = null,
listInts_Untyped: String? = null,
+ listIntsExpression: Expression? = null,
listEnums_Untyped: String? = null,
+ listEnumsExpression: Expression? = null,
listIntSpecial_Untyped: String? = null,
+ listIntSpecialExpression: Expression? = null,
_customInputs: Map = mapOf(),
_customVersion: String? = null,
- ) : this(fooBar_Untyped = fooBar_Untyped, bazGoo_Untyped = bazGoo_Untyped, binKin_Untyped =
- binKin_Untyped, intPint_Untyped = intPint_Untyped, floPint_Untyped = floPint_Untyped,
- finBin_Untyped = finBin_Untyped, gooZen_Untyped = gooZen_Untyped, bahEnum_Untyped =
- bahEnum_Untyped, listStrings_Untyped = listStrings_Untyped, listInts_Untyped =
- listInts_Untyped, listEnums_Untyped = listEnums_Untyped, listIntSpecial_Untyped =
- listIntSpecial_Untyped, _customInputs = _customInputs, _customVersion = _customVersion)
+ ) : this(fooBar_Untyped = fooBar_Untyped, fooBarExpression = fooBarExpression, bazGoo_Untyped =
+ bazGoo_Untyped, bazGooExpression = bazGooExpression, binKin_Untyped = binKin_Untyped,
+ binKinExpression = binKinExpression, intPint_Untyped = intPint_Untyped,
+ intPintExpression = intPintExpression, floPint_Untyped = floPint_Untyped,
+ floPintExpression = floPintExpression, finBin_Untyped = finBin_Untyped, finBinExpression
+ = finBinExpression, gooZen_Untyped = gooZen_Untyped, gooZenExpression =
+ gooZenExpression, bahEnum_Untyped = bahEnum_Untyped, bahEnumExpression =
+ bahEnumExpression, listStrings_Untyped = listStrings_Untyped, listStringsExpression =
+ listStringsExpression, listInts_Untyped = listInts_Untyped, listIntsExpression =
+ listIntsExpression, listEnums_Untyped = listEnums_Untyped, listEnumsExpression =
+ listEnumsExpression, listIntSpecial_Untyped = listIntSpecial_Untyped,
+ listIntSpecialExpression = listIntSpecialExpression, _customInputs = _customInputs,
+ _customVersion = _customVersion)
@Suppress("SpreadOperator")
override fun toYamlArguments(): LinkedHashMap = linkedMapOf(
*listOfNotNull(
- "foo-bar" to fooBar_Untyped,
- "baz-goo" to bazGoo_Untyped,
+ fooBar_Untyped?.let { "foo-bar" to it },
+ fooBarExpression?.let { "foo-bar" to it.expressionString },
+ bazGoo_Untyped?.let { "baz-goo" to it },
+ bazGooExpression?.let { "baz-goo" to it.expressionString },
binKin_Untyped?.let { "bin-kin" to it },
- "int-pint" to intPint_Untyped,
- "flo-pint" to floPint_Untyped,
- "fin-bin" to finBin_Untyped,
- "goo-zen" to gooZen_Untyped,
- "bah-enum" to bahEnum_Untyped,
+ binKinExpression?.let { "bin-kin" to it.expressionString },
+ intPint_Untyped?.let { "int-pint" to it },
+ intPintExpression?.let { "int-pint" to it.expressionString },
+ floPint_Untyped?.let { "flo-pint" to it },
+ floPintExpression?.let { "flo-pint" to it.expressionString },
+ finBin_Untyped?.let { "fin-bin" to it },
+ finBinExpression?.let { "fin-bin" to it.expressionString },
+ gooZen_Untyped?.let { "goo-zen" to it },
+ gooZenExpression?.let { "goo-zen" to it.expressionString },
+ bahEnum_Untyped?.let { "bah-enum" to it },
+ bahEnumExpression?.let { "bah-enum" to it.expressionString },
listStrings_Untyped?.let { "list-strings" to it },
+ listStringsExpression?.let { "list-strings" to it.expressionString },
listInts_Untyped?.let { "list-ints" to it },
+ listIntsExpression?.let { "list-ints" to it.expressionString },
listEnums_Untyped?.let { "list-enums" to it },
+ listEnumsExpression?.let { "list-enums" to it.expressionString },
listIntSpecial_Untyped?.let { "list-int-special" to it },
+ listIntSpecialExpression?.let { "list-int-special" to it.expressionString },
*_customInputs.toList().toTypedArray(),
).toTypedArray()
)
@@ -177,8 +344,66 @@ public data class ActionWithAllTypesOfInputs_Untyped private constructor(
stepId: String,
) : Action.Outputs(stepId) {
/**
- * Cool output!
+ * Short description output
+ */
+ public val fooBar_Untyped: Expression = Expression("steps.$stepId.outputs.foo-bar")
+
+ /**
+ * First boolean input! output
+ */
+ public val bazGoo_Untyped: Expression = Expression("steps.$stepId.outputs.baz-goo")
+
+ /**
+ * Boolean and nullable output
+ */
+ public val binKin_Untyped: Expression = Expression("steps.$stepId.outputs.bin-kin")
+
+ /**
+ * Integer output
+ */
+ public val intPint_Untyped: Expression = Expression("steps.$stepId.outputs.int-pint")
+
+ /**
+ * Float output
+ */
+ public val floPint_Untyped: Expression = Expression("steps.$stepId.outputs.flo-pint")
+
+ /**
+ * Enumeration output
+ */
+ public val finBin_Untyped: Expression = Expression("steps.$stepId.outputs.fin-bin")
+
+ /**
+ * Integer with special value output
+ */
+ public val gooZen_Untyped: Expression = Expression("steps.$stepId.outputs.goo-zen")
+
+ /**
+ * Enum with custom naming output
+ */
+ public val bahEnum_Untyped: Expression = Expression("steps.$stepId.outputs.bah-enum")
+
+ /**
+ * List of strings output
+ */
+ public val listStrings_Untyped: Expression =
+ Expression("steps.$stepId.outputs.list-strings")
+
+ /**
+ * List of integers output
+ */
+ public val listInts_Untyped: Expression = Expression("steps.$stepId.outputs.list-ints")
+
+ /**
+ * List of enums output
+ */
+ public val listEnums_Untyped: Expression =
+ Expression("steps.$stepId.outputs.list-enums")
+
+ /**
+ * List of integer with special values output
*/
- public val bazGoo: String = "steps.$stepId.outputs.baz-goo"
+ public val listIntSpecial_Untyped: Expression =
+ Expression("steps.$stepId.outputs.list-int-special")
}
}
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithDeprecatedInputAndNameClash.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithDeprecatedInputAndNameClash.kt
index 8d43c8b464..b9fb4db7fe 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithDeprecatedInputAndNameClash.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithDeprecatedInputAndNameClash.kt
@@ -4,14 +4,17 @@
@file:Suppress(
"DataClassPrivateConstructor",
"UNUSED_PARAMETER",
+ "DEPRECATION",
)
package io.github.typesafegithub.workflows.actions.johnsmith
+import io.github.typesafegithub.workflows.domain.Expression
import io.github.typesafegithub.workflows.domain.actions.Action
import io.github.typesafegithub.workflows.domain.actions.RegularAction
import java.util.LinkedHashMap
import kotlin.ConsistentCopyVisibility
+import kotlin.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
@@ -28,6 +31,7 @@ import kotlin.collections.toTypedArray
*
* @param fooBar <required> Foo bar - new
* @param fooBar_Untyped <required> Foo bar - new
+ * @param fooBarExpression <required> Foo bar - new
* @param _customInputs Type-unsafe map where you can put any inputs that are not yet supported by
* the binding
* @param _customVersion Allows overriding action's version, for example to use a specific minor
@@ -42,7 +46,12 @@ public data class ActionWithDeprecatedInputAndNameClash private constructor(
/**
* <required> Foo bar - new
*/
+ @Deprecated("Use the typed property or expression property instead")
public val fooBar_Untyped: String? = null,
+ /**
+ * <required> Foo bar - new
+ */
+ public val fooBarExpression: Expression? = null,
/**
* Type-unsafe map where you can put any inputs that are not yet supported by the binding
*/
@@ -55,11 +64,12 @@ public data class ActionWithDeprecatedInputAndNameClash private constructor(
) : RegularAction("john-smith", "action-with-deprecated-input-and-name-clash",
_customVersion ?: "v2") {
init {
- require(!((fooBar != null) && (fooBar_Untyped != null))) {
- "Only fooBar or fooBar_Untyped must be set, but not both"
+ require(listOfNotNull(fooBar, fooBar_Untyped, fooBarExpression).size <= 1) {
+ "Only one of fooBar, fooBar_Untyped, and fooBarExpression must be set, but not multiple"
}
- require((fooBar != null) || (fooBar_Untyped != null)) {
- "Either fooBar or fooBar_Untyped must be set, one of them is required"
+ require((fooBar != null) || (fooBar_Untyped != null) || (fooBarExpression != null)) {
+
+ "Either fooBar, fooBar_Untyped, or fooBarExpression must be set, one of them is required"
}
}
@@ -67,16 +77,18 @@ public data class ActionWithDeprecatedInputAndNameClash private constructor(
vararg pleaseUseNamedArguments: Unit,
fooBar: String? = null,
fooBar_Untyped: String? = null,
+ fooBarExpression: Expression? = null,
_customInputs: Map = mapOf(),
_customVersion: String? = null,
- ) : this(fooBar = fooBar, fooBar_Untyped = fooBar_Untyped, _customInputs = _customInputs,
- _customVersion = _customVersion)
+ ) : this(fooBar = fooBar, fooBar_Untyped = fooBar_Untyped, fooBarExpression = fooBarExpression,
+ _customInputs = _customInputs, _customVersion = _customVersion)
@Suppress("SpreadOperator")
override fun toYamlArguments(): LinkedHashMap = linkedMapOf(
*listOfNotNull(
fooBar?.let { "fooBar" to it },
fooBar_Untyped?.let { "fooBar" to it },
+ fooBarExpression?.let { "fooBar" to it.expressionString },
*_customInputs.toList().toTypedArray(),
).toTypedArray()
)
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithFancyCharsInDocs.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithFancyCharsInDocs.kt
index 32520c1b6c..3c6e02bba9 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithFancyCharsInDocs.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithFancyCharsInDocs.kt
@@ -4,14 +4,17 @@
@file:Suppress(
"DataClassPrivateConstructor",
"UNUSED_PARAMETER",
+ "DEPRECATION",
)
package io.github.typesafegithub.workflows.actions.johnsmith
+import io.github.typesafegithub.workflows.domain.Expression
import io.github.typesafegithub.workflows.domain.actions.Action
import io.github.typesafegithub.workflows.domain.actions.RegularAction
import java.util.LinkedHashMap
import kotlin.ConsistentCopyVisibility
+import kotlin.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
@@ -28,8 +31,10 @@ import kotlin.collections.toTypedArray
*
* @param nestedKotlinComments This is a /* test */
* @param nestedKotlinComments_Untyped This is a /* test */
+ * @param nestedKotlinCommentsExpression This is a /* test */
* @param percent For example "100%"
* @param percent_Untyped For example "100%"
+ * @param percentExpression For example "100%"
* @param _customInputs Type-unsafe map where you can put any inputs that are not yet supported by
* the binding
* @param _customVersion Allows overriding action's version, for example to use a specific minor
@@ -44,7 +49,12 @@ public data class ActionWithFancyCharsInDocs private constructor(
/**
* This is a /* test */
*/
+ @Deprecated("Use the typed property or expression property instead")
public val nestedKotlinComments_Untyped: String? = null,
+ /**
+ * This is a /* test */
+ */
+ public val nestedKotlinCommentsExpression: Expression? = null,
/**
* For example "100%"
*/
@@ -52,7 +62,12 @@ public data class ActionWithFancyCharsInDocs private constructor(
/**
* For example "100%"
*/
+ @Deprecated("Use the typed property or expression property instead")
public val percent_Untyped: String? = null,
+ /**
+ * For example "100%"
+ */
+ public val percentExpression: Expression? = null,
/**
* Type-unsafe map where you can put any inputs that are not yet supported by the binding
*/
@@ -65,12 +80,15 @@ public data class ActionWithFancyCharsInDocs private constructor(
) : RegularAction("john-smith", "action-with-fancy-chars-in-docs", _customVersion ?:
"v3") {
init {
- require(!((nestedKotlinComments != null) && (nestedKotlinComments_Untyped != null))) {
- "Only nestedKotlinComments or nestedKotlinComments_Untyped must be set, but not both"
+ require(listOfNotNull(nestedKotlinComments, nestedKotlinComments_Untyped,
+ nestedKotlinCommentsExpression).size <= 1) {
+
+ "Only one of nestedKotlinComments, nestedKotlinComments_Untyped, and nestedKotlinCommentsExpression must be set, but not multiple"
}
- require(!((percent != null) && (percent_Untyped != null))) {
- "Only percent or percent_Untyped must be set, but not both"
+ require(listOfNotNull(percent, percent_Untyped, percentExpression).size <= 1) {
+
+ "Only one of percent, percent_Untyped, and percentExpression must be set, but not multiple"
}
}
@@ -78,21 +96,27 @@ public data class ActionWithFancyCharsInDocs private constructor(
vararg pleaseUseNamedArguments: Unit,
nestedKotlinComments: String? = null,
nestedKotlinComments_Untyped: String? = null,
+ nestedKotlinCommentsExpression: Expression? = null,
percent: String? = null,
percent_Untyped: String? = null,
+ percentExpression: Expression? = null,
_customInputs: Map = mapOf(),
_customVersion: String? = null,
) : this(nestedKotlinComments = nestedKotlinComments, nestedKotlinComments_Untyped =
- nestedKotlinComments_Untyped, percent = percent, percent_Untyped = percent_Untyped,
- _customInputs = _customInputs, _customVersion = _customVersion)
+ nestedKotlinComments_Untyped, nestedKotlinCommentsExpression =
+ nestedKotlinCommentsExpression, percent = percent, percent_Untyped = percent_Untyped,
+ percentExpression = percentExpression, _customInputs = _customInputs, _customVersion =
+ _customVersion)
@Suppress("SpreadOperator")
override fun toYamlArguments(): LinkedHashMap = linkedMapOf(
*listOfNotNull(
nestedKotlinComments?.let { "nested-kotlin-comments" to it },
nestedKotlinComments_Untyped?.let { "nested-kotlin-comments" to it },
+ nestedKotlinCommentsExpression?.let { "nested-kotlin-comments" to it.expressionString },
percent?.let { "percent" to it },
percent_Untyped?.let { "percent" to it },
+ percentExpression?.let { "percent" to it.expressionString },
*_customInputs.toList().toTypedArray(),
).toTypedArray()
)
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithInputsSharingType.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithInputsSharingType.kt
index e37803cb95..0095d4c340 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithInputsSharingType.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithInputsSharingType.kt
@@ -4,14 +4,17 @@
@file:Suppress(
"DataClassPrivateConstructor",
"UNUSED_PARAMETER",
+ "DEPRECATION",
)
package io.github.typesafegithub.workflows.actions.johnsmith
+import io.github.typesafegithub.workflows.domain.Expression
import io.github.typesafegithub.workflows.domain.actions.Action
import io.github.typesafegithub.workflows.domain.actions.RegularAction
import java.util.LinkedHashMap
import kotlin.ConsistentCopyVisibility
+import kotlin.Deprecated
import kotlin.Int
import kotlin.String
import kotlin.Suppress
@@ -29,8 +32,10 @@ import kotlin.collections.toTypedArray
*
* @param fooOne <required>
* @param fooOne_Untyped <required>
+ * @param fooOneExpression <required>
* @param fooTwo <required>
* @param fooTwo_Untyped <required>
+ * @param fooTwoExpression <required>
* @param _customInputs Type-unsafe map where you can put any inputs that are not yet supported by
* the binding
* @param _customVersion Allows overriding action's version, for example to use a specific minor
@@ -45,7 +50,12 @@ public data class ActionWithInputsSharingType private constructor(
/**
* <required>
*/
+ @Deprecated("Use the typed property or expression property instead")
public val fooOne_Untyped: String? = null,
+ /**
+ * <required>
+ */
+ public val fooOneExpression: Expression? = null,
/**
* <required>
*/
@@ -53,9 +63,16 @@ public data class ActionWithInputsSharingType private constructor(
/**
* <required>
*/
+ @Deprecated("Use the typed property or expression property instead")
public val fooTwo_Untyped: String? = null,
+ /**
+ * <required>
+ */
+ public val fooTwoExpression: Expression? = null,
public val fooThree: ActionWithInputsSharingType.Foo? = null,
+ @Deprecated("Use the typed property or expression property instead")
public val fooThree_Untyped: String? = null,
+ public val fooThreeExpression: Expression? = null,
/**
* Type-unsafe map where you can put any inputs that are not yet supported by the binding
*/
@@ -68,22 +85,25 @@ public data class ActionWithInputsSharingType private constructor(
) : RegularAction("john-smith", "action-with-inputs-sharing-type", _customVersion ?:
"v3") {
init {
- require(!((fooOne != null) && (fooOne_Untyped != null))) {
- "Only fooOne or fooOne_Untyped must be set, but not both"
+ require(listOfNotNull(fooOne, fooOne_Untyped, fooOneExpression).size <= 1) {
+ "Only one of fooOne, fooOne_Untyped, and fooOneExpression must be set, but not multiple"
}
- require((fooOne != null) || (fooOne_Untyped != null)) {
- "Either fooOne or fooOne_Untyped must be set, one of them is required"
+ require((fooOne != null) || (fooOne_Untyped != null) || (fooOneExpression != null)) {
+
+ "Either fooOne, fooOne_Untyped, or fooOneExpression must be set, one of them is required"
}
- require(!((fooTwo != null) && (fooTwo_Untyped != null))) {
- "Only fooTwo or fooTwo_Untyped must be set, but not both"
+ require(listOfNotNull(fooTwo, fooTwo_Untyped, fooTwoExpression).size <= 1) {
+ "Only one of fooTwo, fooTwo_Untyped, and fooTwoExpression must be set, but not multiple"
}
- require((fooTwo != null) || (fooTwo_Untyped != null)) {
- "Either fooTwo or fooTwo_Untyped must be set, one of them is required"
+ require((fooTwo != null) || (fooTwo_Untyped != null) || (fooTwoExpression != null)) {
+
+ "Either fooTwo, fooTwo_Untyped, or fooTwoExpression must be set, one of them is required"
}
- require(!((fooThree != null) && (fooThree_Untyped != null))) {
- "Only fooThree or fooThree_Untyped must be set, but not both"
+ require(listOfNotNull(fooThree, fooThree_Untyped, fooThreeExpression).size <= 1) {
+
+ "Only one of fooThree, fooThree_Untyped, and fooThreeExpression must be set, but not multiple"
}
}
@@ -91,25 +111,32 @@ public data class ActionWithInputsSharingType private constructor(
vararg pleaseUseNamedArguments: Unit,
fooOne: ActionWithInputsSharingType.Foo? = null,
fooOne_Untyped: String? = null,
+ fooOneExpression: Expression? = null,
fooTwo: ActionWithInputsSharingType.Foo? = null,
fooTwo_Untyped: String? = null,
+ fooTwoExpression: Expression? = null,
fooThree: ActionWithInputsSharingType.Foo? = null,
fooThree_Untyped: String? = null,
+ fooThreeExpression: Expression? = null,
_customInputs: Map = mapOf(),
_customVersion: String? = null,
- ) : this(fooOne = fooOne, fooOne_Untyped = fooOne_Untyped, fooTwo = fooTwo, fooTwo_Untyped =
- fooTwo_Untyped, fooThree = fooThree, fooThree_Untyped = fooThree_Untyped, _customInputs
- = _customInputs, _customVersion = _customVersion)
+ ) : this(fooOne = fooOne, fooOne_Untyped = fooOne_Untyped, fooOneExpression = fooOneExpression,
+ fooTwo = fooTwo, fooTwo_Untyped = fooTwo_Untyped, fooTwoExpression = fooTwoExpression,
+ fooThree = fooThree, fooThree_Untyped = fooThree_Untyped, fooThreeExpression =
+ fooThreeExpression, _customInputs = _customInputs, _customVersion = _customVersion)
@Suppress("SpreadOperator")
override fun toYamlArguments(): LinkedHashMap = linkedMapOf(
*listOfNotNull(
fooOne?.let { "foo-one" to it.integerValue.toString() },
fooOne_Untyped?.let { "foo-one" to it },
+ fooOneExpression?.let { "foo-one" to it.expressionString },
fooTwo?.let { "foo-two" to it.integerValue.toString() },
fooTwo_Untyped?.let { "foo-two" to it },
+ fooTwoExpression?.let { "foo-two" to it.expressionString },
fooThree?.let { "foo-three" to it.integerValue.toString() },
fooThree_Untyped?.let { "foo-three" to it },
+ fooThreeExpression?.let { "foo-three" to it.expressionString },
*_customInputs.toList().toTypedArray(),
).toTypedArray()
)
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithNoInputs.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithNoInputs.kt
index bae00cd876..94975bf566 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithNoInputs.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithNoInputs.kt
@@ -4,6 +4,7 @@
@file:Suppress(
"DataClassPrivateConstructor",
"UNUSED_PARAMETER",
+ "DEPRECATION",
)
package io.github.typesafegithub.workflows.actions.johnsmith
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithNoTypings_Untyped.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithNoTypings_Untyped.kt
index a1cdf3cac2..684ebab838 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithNoTypings_Untyped.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithNoTypings_Untyped.kt
@@ -4,10 +4,12 @@
@file:Suppress(
"DataClassPrivateConstructor",
"UNUSED_PARAMETER",
+ "DEPRECATION",
)
package io.github.typesafegithub.workflows.actions.johnsmith
+import io.github.typesafegithub.workflows.domain.Expression
import io.github.typesafegithub.workflows.domain.actions.Action
import io.github.typesafegithub.workflows.domain.actions.RegularAction
import java.util.LinkedHashMap
@@ -53,8 +55,10 @@ import kotlin.collections.toTypedArray
*/
@ConsistentCopyVisibility
public data class ActionWithNoTypings_Untyped private constructor(
- public val foo_Untyped: String,
+ public val foo_Untyped: String? = null,
+ public val fooExpression: Expression? = null,
public val bar_Untyped: String? = null,
+ public val barExpression: Expression? = null,
/**
* Type-unsafe map where you can put any inputs that are not yet supported by the binding
*/
@@ -65,20 +69,38 @@ public data class ActionWithNoTypings_Untyped private constructor(
*/
public val _customVersion: String? = null,
) : RegularAction("john-smith", "action-with-no-typings", _customVersion ?: "v3") {
+ init {
+ require(listOfNotNull(foo_Untyped, fooExpression).size <= 1) {
+ "Only one of foo_Untyped, and fooExpression must be set, but not multiple"
+ }
+ require((foo_Untyped != null) || (fooExpression != null)) {
+ "Either foo_Untyped, or fooExpression must be set, one of them is required"
+ }
+
+ require(listOfNotNull(bar_Untyped, barExpression).size <= 1) {
+ "Only one of bar_Untyped, and barExpression must be set, but not multiple"
+ }
+ }
+
public constructor(
vararg pleaseUseNamedArguments: Unit,
- foo_Untyped: String,
+ foo_Untyped: String? = null,
+ fooExpression: Expression? = null,
bar_Untyped: String? = null,
+ barExpression: Expression? = null,
_customInputs: Map = mapOf(),
_customVersion: String? = null,
- ) : this(foo_Untyped = foo_Untyped, bar_Untyped = bar_Untyped, _customInputs = _customInputs,
- _customVersion = _customVersion)
+ ) : this(foo_Untyped = foo_Untyped, fooExpression = fooExpression, bar_Untyped = bar_Untyped,
+ barExpression = barExpression, _customInputs = _customInputs, _customVersion =
+ _customVersion)
@Suppress("SpreadOperator")
override fun toYamlArguments(): LinkedHashMap = linkedMapOf(
*listOfNotNull(
- "foo" to foo_Untyped,
+ foo_Untyped?.let { "foo" to it },
+ fooExpression?.let { "foo" to it.expressionString },
bar_Untyped?.let { "bar" to it },
+ barExpression?.let { "bar" to it.expressionString },
*_customInputs.toList().toTypedArray(),
).toTypedArray()
)
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithOutputs.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithOutputs.kt
index f96546e56e..b7bbb434c7 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithOutputs.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithOutputs.kt
@@ -4,14 +4,18 @@
@file:Suppress(
"DataClassPrivateConstructor",
"UNUSED_PARAMETER",
+ "DEPRECATION",
)
package io.github.typesafegithub.workflows.actions.johnsmith
+import io.github.typesafegithub.workflows.domain.Expression
import io.github.typesafegithub.workflows.domain.actions.Action
import io.github.typesafegithub.workflows.domain.actions.RegularAction
import java.util.LinkedHashMap
+import kotlin.Any
import kotlin.ConsistentCopyVisibility
+import kotlin.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
@@ -28,6 +32,7 @@ import kotlin.collections.toTypedArray
*
* @param fooBar <required> Short description
* @param fooBar_Untyped <required> Short description
+ * @param fooBarExpression <required> Short description
* @param _customInputs Type-unsafe map where you can put any inputs that are not yet supported by
* the binding
* @param _customVersion Allows overriding action's version, for example to use a specific minor
@@ -42,7 +47,12 @@ public data class ActionWithOutputs private constructor(
/**
* <required> Short description
*/
+ @Deprecated("Use the typed property or expression property instead")
public val fooBar_Untyped: String? = null,
+ /**
+ * <required> Short description
+ */
+ public val fooBarExpression: Expression? = null,
/**
* Type-unsafe map where you can put any inputs that are not yet supported by the binding
*/
@@ -55,11 +65,12 @@ public data class ActionWithOutputs private constructor(
) : RegularAction("john-smith", "action-with-outputs", _customVersion ?:
"v3") {
init {
- require(!((fooBar != null) && (fooBar_Untyped != null))) {
- "Only fooBar or fooBar_Untyped must be set, but not both"
+ require(listOfNotNull(fooBar, fooBar_Untyped, fooBarExpression).size <= 1) {
+ "Only one of fooBar, fooBar_Untyped, and fooBarExpression must be set, but not multiple"
}
- require((fooBar != null) || (fooBar_Untyped != null)) {
- "Either fooBar or fooBar_Untyped must be set, one of them is required"
+ require((fooBar != null) || (fooBar_Untyped != null) || (fooBarExpression != null)) {
+
+ "Either fooBar, fooBar_Untyped, or fooBarExpression must be set, one of them is required"
}
}
@@ -67,16 +78,18 @@ public data class ActionWithOutputs private constructor(
vararg pleaseUseNamedArguments: Unit,
fooBar: String? = null,
fooBar_Untyped: String? = null,
+ fooBarExpression: Expression? = null,
_customInputs: Map = mapOf(),
_customVersion: String? = null,
- ) : this(fooBar = fooBar, fooBar_Untyped = fooBar_Untyped, _customInputs = _customInputs,
- _customVersion = _customVersion)
+ ) : this(fooBar = fooBar, fooBar_Untyped = fooBar_Untyped, fooBarExpression = fooBarExpression,
+ _customInputs = _customInputs, _customVersion = _customVersion)
@Suppress("SpreadOperator")
override fun toYamlArguments(): LinkedHashMap = linkedMapOf(
*listOfNotNull(
fooBar?.let { "foo-bar" to it },
fooBar_Untyped?.let { "foo-bar" to it },
+ fooBarExpression?.let { "foo-bar" to it.expressionString },
*_customInputs.toList().toTypedArray(),
).toTypedArray()
)
@@ -89,11 +102,11 @@ public data class ActionWithOutputs private constructor(
/**
* Cool output!
*/
- public val bazGoo: String = "steps.$stepId.outputs.baz-goo"
+ public val bazGoo_Untyped: Expression = Expression("steps.$stepId.outputs.baz-goo")
/**
* Another output...
*/
- public val looWoz: String = "steps.$stepId.outputs.loo-woz"
+ public val looWoz_Untyped: Expression = Expression("steps.$stepId.outputs.loo-woz")
}
}
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithOutputsTest.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithOutputsTest.kt
index 780b36f6af..7277677a4b 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithOutputsTest.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithOutputsTest.kt
@@ -1,6 +1,7 @@
package io.github.typesafegithub.workflows.actionbindinggenerator.bindingsfromunittests
import io.github.typesafegithub.workflows.actions.johnsmith.ActionWithOutputs
+import io.github.typesafegithub.workflows.domain.Expression
import io.kotest.core.spec.style.DescribeSpec
import io.kotest.matchers.shouldBe
@@ -10,8 +11,8 @@ class ActionWithOutputsTest : DescribeSpec({
val outputs = ActionWithOutputs(fooBar = "1").buildOutputObject("someStepId")
// when & then
- outputs.bazGoo shouldBe "steps.someStepId.outputs.baz-goo"
- outputs.looWoz shouldBe "steps.someStepId.outputs.loo-woz"
- outputs["custom-output"] shouldBe "steps.someStepId.outputs.custom-output"
+ outputs.bazGoo_Untyped shouldBe Expression("steps.someStepId.outputs.baz-goo")
+ outputs.looWoz_Untyped shouldBe Expression("steps.someStepId.outputs.loo-woz")
+ outputs["custom-output"] shouldBe Expression("steps.someStepId.outputs.custom-output")
}
})
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithPartlyTypings.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithPartlyTypings.kt
index 517f1a4574..94d7968728 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithPartlyTypings.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithPartlyTypings.kt
@@ -4,14 +4,17 @@
@file:Suppress(
"DataClassPrivateConstructor",
"UNUSED_PARAMETER",
+ "DEPRECATION",
)
package io.github.typesafegithub.workflows.actions.johnsmith
+import io.github.typesafegithub.workflows.domain.Expression
import io.github.typesafegithub.workflows.domain.actions.Action
import io.github.typesafegithub.workflows.domain.actions.RegularAction
import java.util.LinkedHashMap
import kotlin.ConsistentCopyVisibility
+import kotlin.Deprecated
import kotlin.Int
import kotlin.String
import kotlin.Suppress
@@ -29,6 +32,7 @@ import kotlin.collections.toTypedArray
*
* @param foo <required>
* @param foo_Untyped <required>
+ * @param fooExpression <required>
* @param _customInputs Type-unsafe map where you can put any inputs that are not yet supported by
* the binding
* @param _customVersion Allows overriding action's version, for example to use a specific minor
@@ -43,9 +47,16 @@ public data class ActionWithPartlyTypings private constructor(
/**
* <required>
*/
+ @Deprecated("Use the typed property or expression property instead")
public val foo_Untyped: String? = null,
+ /**
+ * <required>
+ */
+ public val fooExpression: Expression? = null,
public val bar_Untyped: String? = null,
- public val baz_Untyped: String,
+ public val barExpression: Expression? = null,
+ public val baz_Untyped: String? = null,
+ public val bazExpression: Expression? = null,
/**
* Type-unsafe map where you can put any inputs that are not yet supported by the binding
*/
@@ -58,11 +69,22 @@ public data class ActionWithPartlyTypings private constructor(
) : RegularAction("john-smith", "action-with-partly-typings", _customVersion ?:
"v3") {
init {
- require(!((foo != null) && (foo_Untyped != null))) {
- "Only foo or foo_Untyped must be set, but not both"
+ require(listOfNotNull(foo, foo_Untyped, fooExpression).size <= 1) {
+ "Only one of foo, foo_Untyped, and fooExpression must be set, but not multiple"
+ }
+ require((foo != null) || (foo_Untyped != null) || (fooExpression != null)) {
+ "Either foo, foo_Untyped, or fooExpression must be set, one of them is required"
+ }
+
+ require(listOfNotNull(bar_Untyped, barExpression).size <= 1) {
+ "Only one of bar_Untyped, and barExpression must be set, but not multiple"
+ }
+
+ require(listOfNotNull(baz_Untyped, bazExpression).size <= 1) {
+ "Only one of baz_Untyped, and bazExpression must be set, but not multiple"
}
- require((foo != null) || (foo_Untyped != null)) {
- "Either foo or foo_Untyped must be set, one of them is required"
+ require((baz_Untyped != null) || (bazExpression != null)) {
+ "Either baz_Untyped, or bazExpression must be set, one of them is required"
}
}
@@ -70,20 +92,27 @@ public data class ActionWithPartlyTypings private constructor(
vararg pleaseUseNamedArguments: Unit,
foo: Int? = null,
foo_Untyped: String? = null,
+ fooExpression: Expression? = null,
bar_Untyped: String? = null,
- baz_Untyped: String,
+ barExpression: Expression? = null,
+ baz_Untyped: String? = null,
+ bazExpression: Expression? = null,
_customInputs: Map = mapOf(),
_customVersion: String? = null,
- ) : this(foo = foo, foo_Untyped = foo_Untyped, bar_Untyped = bar_Untyped, baz_Untyped =
- baz_Untyped, _customInputs = _customInputs, _customVersion = _customVersion)
+ ) : this(foo = foo, foo_Untyped = foo_Untyped, fooExpression = fooExpression, bar_Untyped =
+ bar_Untyped, barExpression = barExpression, baz_Untyped = baz_Untyped, bazExpression =
+ bazExpression, _customInputs = _customInputs, _customVersion = _customVersion)
@Suppress("SpreadOperator")
override fun toYamlArguments(): LinkedHashMap = linkedMapOf(
*listOfNotNull(
foo?.let { "foo" to it.toString() },
foo_Untyped?.let { "foo" to it },
+ fooExpression?.let { "foo" to it.expressionString },
bar_Untyped?.let { "bar" to it },
- "baz" to baz_Untyped,
+ barExpression?.let { "bar" to it.expressionString },
+ baz_Untyped?.let { "baz" to it },
+ bazExpression?.let { "baz" to it.expressionString },
*_customInputs.toList().toTypedArray(),
).toTypedArray()
)
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithPartlyTypings_Untyped.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithPartlyTypings_Untyped.kt
index 357dd648bf..d6703dc142 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithPartlyTypings_Untyped.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithPartlyTypings_Untyped.kt
@@ -4,10 +4,12 @@
@file:Suppress(
"DataClassPrivateConstructor",
"UNUSED_PARAMETER",
+ "DEPRECATION",
)
package io.github.typesafegithub.workflows.actions.johnsmith
+import io.github.typesafegithub.workflows.domain.Expression
import io.github.typesafegithub.workflows.domain.actions.Action
import io.github.typesafegithub.workflows.domain.actions.RegularAction
import java.util.LinkedHashMap
@@ -58,9 +60,12 @@ import kotlin.collections.toTypedArray
)
@ConsistentCopyVisibility
public data class ActionWithPartlyTypings_Untyped private constructor(
- public val foo_Untyped: String,
+ public val foo_Untyped: String? = null,
+ public val fooExpression: Expression? = null,
public val bar_Untyped: String? = null,
- public val baz_Untyped: String,
+ public val barExpression: Expression? = null,
+ public val baz_Untyped: String? = null,
+ public val bazExpression: Expression? = null,
/**
* Type-unsafe map where you can put any inputs that are not yet supported by the binding
*/
@@ -72,22 +77,49 @@ public data class ActionWithPartlyTypings_Untyped private constructor(
public val _customVersion: String? = null,
) : RegularAction("john-smith", "action-with-partly-typings", _customVersion ?:
"v3") {
+ init {
+ require(listOfNotNull(foo_Untyped, fooExpression).size <= 1) {
+ "Only one of foo_Untyped, and fooExpression must be set, but not multiple"
+ }
+ require((foo_Untyped != null) || (fooExpression != null)) {
+ "Either foo_Untyped, or fooExpression must be set, one of them is required"
+ }
+
+ require(listOfNotNull(bar_Untyped, barExpression).size <= 1) {
+ "Only one of bar_Untyped, and barExpression must be set, but not multiple"
+ }
+
+ require(listOfNotNull(baz_Untyped, bazExpression).size <= 1) {
+ "Only one of baz_Untyped, and bazExpression must be set, but not multiple"
+ }
+ require((baz_Untyped != null) || (bazExpression != null)) {
+ "Either baz_Untyped, or bazExpression must be set, one of them is required"
+ }
+ }
+
public constructor(
vararg pleaseUseNamedArguments: Unit,
- foo_Untyped: String,
+ foo_Untyped: String? = null,
+ fooExpression: Expression? = null,
bar_Untyped: String? = null,
- baz_Untyped: String,
+ barExpression: Expression? = null,
+ baz_Untyped: String? = null,
+ bazExpression: Expression? = null,
_customInputs: Map = mapOf(),
_customVersion: String? = null,
- ) : this(foo_Untyped = foo_Untyped, bar_Untyped = bar_Untyped, baz_Untyped = baz_Untyped,
+ ) : this(foo_Untyped = foo_Untyped, fooExpression = fooExpression, bar_Untyped = bar_Untyped,
+ barExpression = barExpression, baz_Untyped = baz_Untyped, bazExpression = bazExpression,
_customInputs = _customInputs, _customVersion = _customVersion)
@Suppress("SpreadOperator")
override fun toYamlArguments(): LinkedHashMap = linkedMapOf(
*listOfNotNull(
- "foo" to foo_Untyped,
+ foo_Untyped?.let { "foo" to it },
+ fooExpression?.let { "foo" to it.expressionString },
bar_Untyped?.let { "bar" to it },
- "baz" to baz_Untyped,
+ barExpression?.let { "bar" to it.expressionString },
+ baz_Untyped?.let { "baz" to it },
+ bazExpression?.let { "baz" to it.expressionString },
*_customInputs.toList().toTypedArray(),
).toTypedArray()
)
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithSomeOptionalInputs.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithSomeOptionalInputs.kt
index 7be91a091f..5ede37b212 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithSomeOptionalInputs.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/ActionWithSomeOptionalInputs.kt
@@ -4,14 +4,17 @@
@file:Suppress(
"DataClassPrivateConstructor",
"UNUSED_PARAMETER",
+ "DEPRECATION",
)
package io.github.typesafegithub.workflows.actions.johnsmith
+import io.github.typesafegithub.workflows.domain.Expression
import io.github.typesafegithub.workflows.domain.actions.Action
import io.github.typesafegithub.workflows.domain.actions.RegularAction
import java.util.LinkedHashMap
import kotlin.ConsistentCopyVisibility
+import kotlin.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
@@ -28,14 +31,19 @@ import kotlin.collections.toTypedArray
*
* @param fooBar Required is default, default is set
* @param fooBar_Untyped Required is default, default is set
+ * @param fooBarExpression Required is default, default is set
* @param bazGoo Required is default, default is null
* @param bazGoo_Untyped Required is default, default is null
+ * @param bazGooExpression Required is default, default is null
* @param zooDar Required is false, default is set
* @param zooDar_Untyped Required is false, default is set
+ * @param zooDarExpression Required is false, default is set
* @param cooPoo Required is false, default is default
* @param cooPoo_Untyped Required is false, default is default
+ * @param cooPooExpression Required is false, default is default
* @param package <required> Required is true, default is default
* @param package_Untyped <required> Required is true, default is default
+ * @param packageExpression <required> Required is true, default is default
* @param _customInputs Type-unsafe map where you can put any inputs that are not yet supported by
* the binding
* @param _customVersion Allows overriding action's version, for example to use a specific minor
@@ -50,7 +58,12 @@ public data class ActionWithSomeOptionalInputs private constructor(
/**
* Required is default, default is set
*/
+ @Deprecated("Use the typed property or expression property instead")
public val fooBar_Untyped: String? = null,
+ /**
+ * Required is default, default is set
+ */
+ public val fooBarExpression: Expression? = null,
/**
* Required is default, default is null
*/
@@ -58,7 +71,12 @@ public data class ActionWithSomeOptionalInputs private constructor(
/**
* Required is default, default is null
*/
+ @Deprecated("Use the typed property or expression property instead")
public val bazGoo_Untyped: String? = null,
+ /**
+ * Required is default, default is null
+ */
+ public val bazGooExpression: Expression? = null,
/**
* Required is false, default is set
*/
@@ -66,7 +84,12 @@ public data class ActionWithSomeOptionalInputs private constructor(
/**
* Required is false, default is set
*/
+ @Deprecated("Use the typed property or expression property instead")
public val zooDar_Untyped: String? = null,
+ /**
+ * Required is false, default is set
+ */
+ public val zooDarExpression: Expression? = null,
/**
* Required is false, default is default
*/
@@ -74,7 +97,12 @@ public data class ActionWithSomeOptionalInputs private constructor(
/**
* Required is false, default is default
*/
+ @Deprecated("Use the typed property or expression property instead")
public val cooPoo_Untyped: String? = null,
+ /**
+ * Required is false, default is default
+ */
+ public val cooPooExpression: Expression? = null,
/**
* <required> Required is true, default is default
*/
@@ -82,7 +110,12 @@ public data class ActionWithSomeOptionalInputs private constructor(
/**
* <required> Required is true, default is default
*/
+ @Deprecated("Use the typed property or expression property instead")
public val package_Untyped: String? = null,
+ /**
+ * <required> Required is true, default is default
+ */
+ public val packageExpression: Expression? = null,
/**
* Type-unsafe map where you can put any inputs that are not yet supported by the binding
*/
@@ -95,27 +128,29 @@ public data class ActionWithSomeOptionalInputs private constructor(
) : RegularAction("john-smith", "action-with-some-optional-inputs", _customVersion
?: "v3") {
init {
- require(!((fooBar != null) && (fooBar_Untyped != null))) {
- "Only fooBar or fooBar_Untyped must be set, but not both"
+ require(listOfNotNull(fooBar, fooBar_Untyped, fooBarExpression).size <= 1) {
+ "Only one of fooBar, fooBar_Untyped, and fooBarExpression must be set, but not multiple"
}
- require(!((bazGoo != null) && (bazGoo_Untyped != null))) {
- "Only bazGoo or bazGoo_Untyped must be set, but not both"
+ require(listOfNotNull(bazGoo, bazGoo_Untyped, bazGooExpression).size <= 1) {
+ "Only one of bazGoo, bazGoo_Untyped, and bazGooExpression must be set, but not multiple"
}
- require(!((zooDar != null) && (zooDar_Untyped != null))) {
- "Only zooDar or zooDar_Untyped must be set, but not both"
+ require(listOfNotNull(zooDar, zooDar_Untyped, zooDarExpression).size <= 1) {
+ "Only one of zooDar, zooDar_Untyped, and zooDarExpression must be set, but not multiple"
}
- require(!((cooPoo != null) && (cooPoo_Untyped != null))) {
- "Only cooPoo or cooPoo_Untyped must be set, but not both"
+ require(listOfNotNull(cooPoo, cooPoo_Untyped, cooPooExpression).size <= 1) {
+ "Only one of cooPoo, cooPoo_Untyped, and cooPooExpression must be set, but not multiple"
}
- require(!((`package` != null) && (package_Untyped != null))) {
- "Only package or package_Untyped must be set, but not both"
+ require(listOfNotNull(`package`, package_Untyped, packageExpression).size <= 1) {
+
+ "Only one of package, package_Untyped, and packageExpression must be set, but not multiple"
}
- require((`package` != null) || (package_Untyped != null)) {
- "Either package or package_Untyped must be set, one of them is required"
+ require((`package` != null) || (package_Untyped != null) || (packageExpression != null)) {
+
+ "Either package, package_Untyped, or packageExpression must be set, one of them is required"
}
}
@@ -123,34 +158,46 @@ public data class ActionWithSomeOptionalInputs private constructor(
vararg pleaseUseNamedArguments: Unit,
fooBar: String? = null,
fooBar_Untyped: String? = null,
+ fooBarExpression: Expression? = null,
bazGoo: String? = null,
bazGoo_Untyped: String? = null,
+ bazGooExpression: Expression? = null,
zooDar: String? = null,
zooDar_Untyped: String? = null,
+ zooDarExpression: Expression? = null,
cooPoo: String? = null,
cooPoo_Untyped: String? = null,
+ cooPooExpression: Expression? = null,
`package`: String? = null,
package_Untyped: String? = null,
+ packageExpression: Expression? = null,
_customInputs: Map = mapOf(),
_customVersion: String? = null,
- ) : this(fooBar = fooBar, fooBar_Untyped = fooBar_Untyped, bazGoo = bazGoo, bazGoo_Untyped =
- bazGoo_Untyped, zooDar = zooDar, zooDar_Untyped = zooDar_Untyped, cooPoo = cooPoo,
- cooPoo_Untyped = cooPoo_Untyped, `package` = `package`, package_Untyped =
- package_Untyped, _customInputs = _customInputs, _customVersion = _customVersion)
+ ) : this(fooBar = fooBar, fooBar_Untyped = fooBar_Untyped, fooBarExpression = fooBarExpression,
+ bazGoo = bazGoo, bazGoo_Untyped = bazGoo_Untyped, bazGooExpression = bazGooExpression,
+ zooDar = zooDar, zooDar_Untyped = zooDar_Untyped, zooDarExpression = zooDarExpression,
+ cooPoo = cooPoo, cooPoo_Untyped = cooPoo_Untyped, cooPooExpression = cooPooExpression,
+ `package` = `package`, package_Untyped = package_Untyped, packageExpression =
+ packageExpression, _customInputs = _customInputs, _customVersion = _customVersion)
@Suppress("SpreadOperator")
override fun toYamlArguments(): LinkedHashMap = linkedMapOf(
*listOfNotNull(
fooBar?.let { "foo-bar" to it },
fooBar_Untyped?.let { "foo-bar" to it },
+ fooBarExpression?.let { "foo-bar" to it.expressionString },
bazGoo?.let { "baz-goo" to it },
bazGoo_Untyped?.let { "baz-goo" to it },
+ bazGooExpression?.let { "baz-goo" to it.expressionString },
zooDar?.let { "zoo-dar" to it },
zooDar_Untyped?.let { "zoo-dar" to it },
+ zooDarExpression?.let { "zoo-dar" to it.expressionString },
cooPoo?.let { "coo-poo" to it },
cooPoo_Untyped?.let { "coo-poo" to it },
+ cooPooExpression?.let { "coo-poo" to it.expressionString },
`package`?.let { "package" to it },
package_Untyped?.let { "package" to it },
+ packageExpression?.let { "package" to it.expressionString },
*_customInputs.toList().toTypedArray(),
).toTypedArray()
)
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/SimpleActionWithRequiredStringInputs.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/SimpleActionWithRequiredStringInputs.kt
index a6d23a2f37..ed11cb360b 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/SimpleActionWithRequiredStringInputs.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/bindingsfromunittests/SimpleActionWithRequiredStringInputs.kt
@@ -9,6 +9,7 @@
package io.github.typesafegithub.workflows.actions.johnsmith
+import io.github.typesafegithub.workflows.domain.Expression
import io.github.typesafegithub.workflows.domain.actions.Action
import io.github.typesafegithub.workflows.domain.actions.RegularAction
import java.util.LinkedHashMap
@@ -31,10 +32,13 @@ import kotlin.collections.toTypedArray
*
* @param fooBar <required> Short description
* @param fooBar_Untyped <required> Short description
+ * @param fooBarExpression <required> Short description
* @param bazGoo <required> Just another input
* with multiline description
* @param bazGoo_Untyped <required> Just another input
* with multiline description
+ * @param bazGooExpression <required> Just another input
+ * with multiline description
* @param _customInputs Type-unsafe map where you can put any inputs that are not yet supported by
* the binding
* @param _customVersion Allows overriding action's version, for example to use a specific minor
@@ -49,7 +53,12 @@ public data class SimpleActionWithRequiredStringInputs private constructor(
/**
* <required> Short description
*/
+ @Deprecated("Use the typed property or expression property instead")
public val fooBar_Untyped: String? = null,
+ /**
+ * <required> Short description
+ */
+ public val fooBarExpression: Expression? = null,
/**
* <required> Just another input
* with multiline description
@@ -62,6 +71,12 @@ public data class SimpleActionWithRequiredStringInputs private constructor(
*/
@Deprecated("this is deprecated")
public val bazGoo_Untyped: String? = null,
+ /**
+ * <required> Just another input
+ * with multiline description
+ */
+ @Deprecated("this is deprecated")
+ public val bazGooExpression: Expression? = null,
/**
* Type-unsafe map where you can put any inputs that are not yet supported by the binding
*/
@@ -74,18 +89,20 @@ public data class SimpleActionWithRequiredStringInputs private constructor(
) : RegularAction("john-smith", "simple-action-with-required-string-inputs",
_customVersion ?: "v3") {
init {
- require(!((fooBar != null) && (fooBar_Untyped != null))) {
- "Only fooBar or fooBar_Untyped must be set, but not both"
+ require(listOfNotNull(fooBar, fooBar_Untyped, fooBarExpression).size <= 1) {
+ "Only one of fooBar, fooBar_Untyped, and fooBarExpression must be set, but not multiple"
}
- require((fooBar != null) || (fooBar_Untyped != null)) {
- "Either fooBar or fooBar_Untyped must be set, one of them is required"
+ require((fooBar != null) || (fooBar_Untyped != null) || (fooBarExpression != null)) {
+
+ "Either fooBar, fooBar_Untyped, or fooBarExpression must be set, one of them is required"
}
- require(!((bazGoo != null) && (bazGoo_Untyped != null))) {
- "Only bazGoo or bazGoo_Untyped must be set, but not both"
+ require(listOfNotNull(bazGoo, bazGoo_Untyped, bazGooExpression).size <= 1) {
+ "Only one of bazGoo, bazGoo_Untyped, and bazGooExpression must be set, but not multiple"
}
- require((bazGoo != null) || (bazGoo_Untyped != null)) {
- "Either bazGoo or bazGoo_Untyped must be set, one of them is required"
+ require((bazGoo != null) || (bazGoo_Untyped != null) || (bazGooExpression != null)) {
+
+ "Either bazGoo, bazGoo_Untyped, or bazGooExpression must be set, one of them is required"
}
}
@@ -93,20 +110,25 @@ public data class SimpleActionWithRequiredStringInputs private constructor(
vararg pleaseUseNamedArguments: Unit,
fooBar: String? = null,
fooBar_Untyped: String? = null,
+ fooBarExpression: Expression? = null,
bazGoo: String? = null,
bazGoo_Untyped: String? = null,
+ bazGooExpression: Expression? = null,
_customInputs: Map = mapOf(),
_customVersion: String? = null,
- ) : this(fooBar = fooBar, fooBar_Untyped = fooBar_Untyped, bazGoo = bazGoo, bazGoo_Untyped =
- bazGoo_Untyped, _customInputs = _customInputs, _customVersion = _customVersion)
+ ) : this(fooBar = fooBar, fooBar_Untyped = fooBar_Untyped, fooBarExpression = fooBarExpression,
+ bazGoo = bazGoo, bazGoo_Untyped = bazGoo_Untyped, bazGooExpression = bazGooExpression,
+ _customInputs = _customInputs, _customVersion = _customVersion)
@Suppress("SpreadOperator")
override fun toYamlArguments(): LinkedHashMap = linkedMapOf(
*listOfNotNull(
fooBar?.let { "foo-bar" to it },
fooBar_Untyped?.let { "foo-bar" to it },
+ fooBarExpression?.let { "foo-bar" to it.expressionString },
bazGoo?.let { "baz-goo" to it },
bazGoo_Untyped?.let { "baz-goo" to it },
+ bazGooExpression?.let { "baz-goo" to it.expressionString },
*_customInputs.toList().toTypedArray(),
).toTypedArray()
)
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/generation/GenerationTest.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/generation/GenerationTest.kt
index f7769c10d0..f9792c2f3e 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/generation/GenerationTest.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/generation/GenerationTest.kt
@@ -1,6 +1,7 @@
package io.github.typesafegithub.workflows.actionbindinggenerator.generation
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
+import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionTypings
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.NewestForVersion
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.TypingActualSource.ACTION
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.TypingActualSource.TYPING_CATALOG
@@ -21,71 +22,72 @@ import io.kotest.matchers.collections.shouldHaveSize
class GenerationTest :
FunSpec({
- val actionManifestWithAllTypesOfInputsAndSomeOutput =
+ val allTypesOfInputs =
+ mapOf(
+ "foo-bar" to
+ Input(
+ description = "Short description",
+ required = true,
+ default = null,
+ ),
+ "baz-goo" to
+ Input(
+ description = "First boolean input!",
+ required = true,
+ default = null,
+ ),
+ "bin-kin" to
+ Input(
+ description = "Boolean and nullable",
+ required = false,
+ default = "test",
+ ),
+ "int-pint" to
+ Input(
+ description = "Integer",
+ required = true,
+ default = null,
+ ),
+ "flo-pint" to
+ Input(
+ description = "Float",
+ required = true,
+ default = null,
+ ),
+ "fin-bin" to
+ Input(
+ description = "Enumeration",
+ required = true,
+ default = null,
+ ),
+ "goo-zen" to
+ Input(
+ description = "Integer with special value",
+ required = true,
+ default = null,
+ ),
+ "bah-enum" to
+ Input(
+ description = "Enum with custom naming",
+ required = true,
+ default = null,
+ ),
+ "list-strings" to Input("List of strings"),
+ "list-ints" to Input("List of integers"),
+ "list-enums" to Input("List of enums"),
+ "list-int-special" to Input("List of integer with special values"),
+ )
+ val actionManifestWithAllTypesOfInputsAndOutputs =
Metadata(
name = "Do something cool",
description = "This is a test description that should be put in the KDoc comment for a class",
- inputs =
- mapOf(
- "foo-bar" to
- Input(
- description = "Short description",
- required = true,
- default = null,
- ),
- "baz-goo" to
- Input(
- description = "First boolean input!",
- required = true,
- default = null,
- ),
- "bin-kin" to
- Input(
- description = "Boolean and nullable",
- required = false,
- default = "test",
- ),
- "int-pint" to
- Input(
- description = "Integer",
- required = true,
- default = null,
- ),
- "flo-pint" to
- Input(
- description = "Float",
- required = true,
- default = null,
- ),
- "fin-bin" to
- Input(
- description = "Enumeration",
- required = true,
- default = null,
- ),
- "goo-zen" to
- Input(
- description = "Integer with special value",
- required = true,
- default = null,
- ),
- "bah-enum" to
- Input(
- description = "Enum with custom naming",
- required = true,
- default = null,
- ),
- "list-strings" to Input("List of strings"),
- "list-ints" to Input("List of integers"),
- "list-enums" to Input("List of enums"),
- "list-int-special" to Input("List of integer with special values"),
- ),
+ inputs = allTypesOfInputs,
outputs =
- mapOf(
- "baz-goo" to Output(description = "Cool output!"),
- ),
+ allTypesOfInputs.mapValues { (_, value) ->
+ Output(description = "${value.description} output")
+ },
)
- val typingsForAllTypesOfInputs =
+ val typingsForAllTypes =
mapOf(
"foo-bar" to StringTyping,
"baz-goo" to BooleanTyping,
@@ -147,7 +149,11 @@ class GenerationTest :
coords.generateBinding(
metadataRevision = NewestForVersion,
metadata = actionManifest,
- inputTypings = Pair(actionManifest.allInputsAsStrings(), ACTION),
+ typings =
+ ActionTypings(
+ inputTypings = actionManifest.allInputsAsStrings(),
+ source = ACTION,
+ ),
)
// then
@@ -197,7 +203,11 @@ class GenerationTest :
coords.generateBinding(
metadataRevision = NewestForVersion,
metadata = actionManifest,
- inputTypings = Pair(actionManifest.allInputsAsStrings(), ACTION),
+ typings =
+ ActionTypings(
+ inputTypings = actionManifest.allInputsAsStrings(),
+ source = ACTION,
+ ),
)
// then
@@ -212,11 +222,12 @@ class GenerationTest :
val binding =
coords.generateBinding(
metadataRevision = NewestForVersion,
- metadata = actionManifestWithAllTypesOfInputsAndSomeOutput,
- inputTypings =
- Pair(
- typingsForAllTypesOfInputs,
- ACTION,
+ metadata = actionManifestWithAllTypesOfInputsAndOutputs,
+ typings =
+ ActionTypings(
+ inputTypings = typingsForAllTypes,
+ outputTypings = typingsForAllTypes,
+ source = ACTION,
),
)
@@ -253,7 +264,11 @@ class GenerationTest :
coords.generateBinding(
metadataRevision = NewestForVersion,
metadata = actionManifest,
- inputTypings = Pair(actionManifest.allInputsAsStrings(), ACTION),
+ typings =
+ ActionTypings(
+ inputTypings = actionManifest.allInputsAsStrings(),
+ source = ACTION,
+ ),
)
// then
@@ -277,7 +292,7 @@ class GenerationTest :
coords.generateBinding(
metadataRevision = NewestForVersion,
metadata = actionManifest,
- inputTypings = Pair(emptyMap(), ACTION),
+ typings = ActionTypings(source = ACTION),
)
// then
@@ -315,7 +330,11 @@ class GenerationTest :
coords.generateBinding(
metadataRevision = NewestForVersion,
metadata = actionManifest,
- inputTypings = Pair(actionManifest.allInputsAsStrings(), ACTION),
+ typings =
+ ActionTypings(
+ inputTypings = actionManifest.allInputsAsStrings(),
+ source = ACTION,
+ ),
)
// then
@@ -354,14 +373,15 @@ class GenerationTest :
coords.generateBinding(
metadataRevision = NewestForVersion,
metadata = actionManifest,
- inputTypings =
- Pair(
- mapOf(
- "foo-one" to IntegerWithSpecialValueTyping("Foo", mapOf("Special1" to 3)),
- "foo-two" to IntegerWithSpecialValueTyping("Foo", mapOf("Special1" to 3)),
- "foo-three" to IntegerWithSpecialValueTyping("Foo", mapOf("Special1" to 3)),
- ),
- ACTION,
+ typings =
+ ActionTypings(
+ inputTypings =
+ mapOf(
+ "foo-one" to IntegerWithSpecialValueTyping("Foo", mapOf("Special1" to 3)),
+ "foo-two" to IntegerWithSpecialValueTyping("Foo", mapOf("Special1" to 3)),
+ "foo-three" to IntegerWithSpecialValueTyping("Foo", mapOf("Special1" to 3)),
+ ),
+ source = ACTION,
),
)
@@ -394,7 +414,11 @@ class GenerationTest :
coords.generateBinding(
metadataRevision = NewestForVersion,
metadata = actionManifest,
- inputTypings = Pair(actionManifest.allInputsAsStrings(), ACTION),
+ typings =
+ ActionTypings(
+ inputTypings = actionManifest.allInputsAsStrings(),
+ source = ACTION,
+ ),
)
// then
@@ -428,7 +452,7 @@ class GenerationTest :
coords.generateBinding(
metadataRevision = NewestForVersion,
metadata = actionManifest,
- inputTypings = Pair(emptyMap(), null),
+ typings = ActionTypings(),
)
// then
@@ -467,7 +491,11 @@ class GenerationTest :
coords.generateBinding(
metadataRevision = NewestForVersion,
metadata = actionManifest,
- inputTypings = Pair(mapOf("foo" to IntegerTyping), TYPING_CATALOG),
+ typings =
+ ActionTypings(
+ inputTypings = mapOf("foo" to IntegerTyping),
+ source = TYPING_CATALOG,
+ ),
)
// then
diff --git a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/typing/TypesProvidingTest.kt b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/typing/TypesProvidingTest.kt
index dee642037b..2c4866087c 100644
--- a/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/typing/TypesProvidingTest.kt
+++ b/action-binding-generator/src/test/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/typing/TypesProvidingTest.kt
@@ -1,6 +1,7 @@
package io.github.typesafegithub.workflows.actionbindinggenerator.typing
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
+import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionTypings
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.CommitHash
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.TypingActualSource
import io.kotest.core.spec.style.FunSpec
@@ -53,7 +54,7 @@ class TypesProvidingTest :
val types = actionCoord.provideTypes(metadataRevision = CommitHash("some-hash"), { actionTypesYml })
// Then
- types.first shouldBe
+ types.inputTypings shouldBe
mapOf(
"name" to StringTyping,
"verbose" to BooleanTyping,
@@ -113,7 +114,11 @@ class TypesProvidingTest :
val types = actionCoord.provideTypes(metadataRevision = CommitHash("some-hash"), fetchUri = fetchUri)
// Then
- types shouldBe Pair(mapOf("hosted-by-action-yml" to StringTyping), TypingActualSource.ACTION)
+ types shouldBe
+ ActionTypings(
+ inputTypings = mapOf("hosted-by-action-yml" to StringTyping),
+ source = TypingActualSource.ACTION,
+ )
}
test("only hosted by the action (.yaml)") {
@@ -130,7 +135,11 @@ class TypesProvidingTest :
val types = actionCoord.provideTypes(metadataRevision = CommitHash("some-hash"), fetchUri = fetchUri)
// Then
- types shouldBe Pair(mapOf("hosted-by-action-yaml" to StringTyping), TypingActualSource.ACTION)
+ types shouldBe
+ ActionTypings(
+ inputTypings = mapOf("hosted-by-action-yaml" to StringTyping),
+ source = TypingActualSource.ACTION,
+ )
}
test("only hosted by the action, both extensions") {
@@ -148,7 +157,11 @@ class TypesProvidingTest :
val types = actionCoord.provideTypes(metadataRevision = CommitHash("some-hash"), fetchUri = fetchUri)
// Then
- types shouldBe Pair(mapOf("hosted-by-action-yml" to StringTyping), TypingActualSource.ACTION)
+ types shouldBe
+ ActionTypings(
+ inputTypings = mapOf("hosted-by-action-yml" to StringTyping),
+ source = TypingActualSource.ACTION,
+ )
}
test("only stored in typing catalog") {
@@ -169,7 +182,11 @@ class TypesProvidingTest :
val types = actionCoord.provideTypes(metadataRevision = CommitHash("some-hash"), fetchUri = fetchUri)
// Then
- types shouldBe Pair(mapOf("stored-in-typing-catalog" to StringTyping), TypingActualSource.TYPING_CATALOG)
+ types shouldBe
+ ActionTypings(
+ inputTypings = mapOf("stored-in-typing-catalog" to StringTyping),
+ source = TypingActualSource.TYPING_CATALOG,
+ )
}
test("hosted by action and stored in typing catalog") {
@@ -195,7 +212,11 @@ class TypesProvidingTest :
val types = actionCoord.provideTypes(metadataRevision = CommitHash("some-hash"), fetchUri = fetchUri)
// Then
- types shouldBe Pair(mapOf("hosted-by-action-yml" to StringTyping), TypingActualSource.ACTION)
+ types shouldBe
+ ActionTypings(
+ inputTypings = mapOf("hosted-by-action-yml" to StringTyping),
+ source = TypingActualSource.ACTION,
+ )
}
test("only stored in typing catalog for older version") {
@@ -221,7 +242,11 @@ class TypesProvidingTest :
val types = actionCoord.provideTypes(metadataRevision = CommitHash("some-hash"), fetchUri = fetchUri)
// Then
- types shouldBe Pair(mapOf("stored-in-typing-catalog-for-older-version" to StringTyping), TypingActualSource.TYPING_CATALOG)
+ types shouldBe
+ ActionTypings(
+ inputTypings = mapOf("stored-in-typing-catalog-for-older-version" to StringTyping),
+ source = TypingActualSource.TYPING_CATALOG,
+ )
}
test("metadata available but no version available") {
@@ -242,7 +267,7 @@ class TypesProvidingTest :
val types = actionCoord.provideTypes(metadataRevision = CommitHash("some-hash"), fetchUri = fetchUri)
// Then
- types shouldBe Pair(emptyMap(), null)
+ types shouldBe ActionTypings()
}
test("no typings at all") {
@@ -254,7 +279,7 @@ class TypesProvidingTest :
val types = actionCoord.provideTypes(metadataRevision = CommitHash("some-hash"), fetchUri = fetchUri)
// Then
- types shouldBe Pair(emptyMap(), null)
+ types shouldBe ActionTypings()
}
}
})
diff --git a/docs/user-guide/migrating-to-Maven-based-bindings.md b/docs/user-guide/migrating-to-Maven-based-bindings.md
index 7c2de7f4ba..c7c3fd3cad 100644
--- a/docs/user-guide/migrating-to-Maven-based-bindings.md
+++ b/docs/user-guide/migrating-to-Maven-based-bindings.md
@@ -99,6 +99,10 @@ Then regenerate your YAML to ensure there are no changes.
typing information there will only be the `_Untyped` property with nullability according to required status.
1. If you used `_customInputs` to set a non-String property to a GitHub Actions expression, you can now instead use
the `_Untyped` property for that input.
+1. If you used outputs anywhere, you will need to adjust your code, as outputs are now typed and of type `Expression`,
+ which can directly be wired to matching inputs' `...Expression` siblings or with the `_Untyped` sibling to any
+ input's `...Expression` sibling. If you need the pure expression, e.g. for usage within a bigger expression,
+ you can also get that from the `Expression` instance.
1. If a given binding has incorrect typing, please either ask the action owner to onboard
[github-action-typing](https://github.com/typesafegithub/github-actions-typing/), or if it's not possible, contribute
to [github-actions-typing-catalog](https://github.com/typesafegithub/github-actions-typing-catalog).
diff --git a/docs/user-guide/using-actions.md b/docs/user-guide/using-actions.md
index c1828fb59f..507fa23875 100644
--- a/docs/user-guide/using-actions.md
+++ b/docs/user-guide/using-actions.md
@@ -21,7 +21,7 @@ To add a dependency on an action:
For every action, a binding will be generated. However, some less popular actions don't have typings configured for
their inputs, so by default all inputs are of type `String`, have the suffix `_Untyped`, and additionally the class
-name will have an `_Untyped` suffix. The nullability of the inputs will be according to their required status.
+name will have an `_Untyped` suffix.
There are two ways of configuring typings:
1. Recommended: a typing manifest (`action-typing.yml`) in the action's repo, see
@@ -37,11 +37,15 @@ There are two ways of configuring typings:
Once there are any typings in place for the action, the `_Untyped` suffixed class is marked `@Deprecated`, and a class
without that suffix is created additionally. In that class for each input that does not have type information available
-there will still be only the property with `_Untyped` suffix and nullability according to required status. For each
-input that does have type information available, there will still be the `_Untyped` property and additionally a
-properly typed property. Both of these properties will be nullable. It is a runtime error to set both of these
-properties as well as setting none if the input is required. The `_Untyped` properties are not marked `@Deprecated`,
-as it could still make sense to use them, for example if you want to set the value from a GitHub Actions expression.
+there will still be only the property with `_Untyped` suffix. For each input that does have type information available,
+there will still be the `_Untyped` property and additionally a properly typed property. It is a runtime error to set
+both of these properties as well as setting none if the input is required.
+
+All inputs also get another `Expression` suffixed property and list-typed inputs yet another `Expressions` suffixed
+property. These properties can e.g. be set type-safely from outputs, as they are of type `Expression`. Each output also
+has an `_Untyped` suffixed property that you can feed to any input expression property. Like with the `_Untyped` input
+property, all up to four properties for the same input are mutually exclusive and for required inputs exactly one has
+to be set, or a runtime error occurs.
This approach supports dependency updating bots that support Kotlin Script's `.main.kts` files. E.g. Renovate is known
to support it.
diff --git a/github-workflows-kt/api/github-workflows-kt.api b/github-workflows-kt/api/github-workflows-kt.api
index a3ad8ecb22..c314def1af 100644
--- a/github-workflows-kt/api/github-workflows-kt.api
+++ b/github-workflows-kt/api/github-workflows-kt.api
@@ -149,6 +149,18 @@ public final class io/github/typesafegithub/workflows/domain/Environment {
public fun toString ()Ljava/lang/String;
}
+public final class io/github/typesafegithub/workflows/domain/Expression {
+ public fun (Ljava/lang/String;)V
+ public final fun component1 ()Ljava/lang/String;
+ public final fun copy (Ljava/lang/String;)Lio/github/typesafegithub/workflows/domain/Expression;
+ public static synthetic fun copy$default (Lio/github/typesafegithub/workflows/domain/Expression;Ljava/lang/String;ILjava/lang/Object;)Lio/github/typesafegithub/workflows/domain/Expression;
+ public fun equals (Ljava/lang/Object;)Z
+ public final fun getExpression ()Ljava/lang/String;
+ public final fun getExpressionString ()Ljava/lang/String;
+ public fun hashCode ()I
+ public fun toString ()Ljava/lang/String;
+}
+
public final class io/github/typesafegithub/workflows/domain/Job : io/github/typesafegithub/workflows/dsl/HasCustomArguments {
public fun (Ljava/lang/String;Ljava/lang/String;Lio/github/typesafegithub/workflows/domain/RunnerType;Ljava/util/List;Ljava/util/List;Lio/github/typesafegithub/workflows/domain/JobOutputs;Ljava/util/Map;Ljava/lang/String;Ljava/util/Map;Ljava/util/Map;Ljava/lang/Integer;Lio/github/typesafegithub/workflows/domain/Concurrency;Lio/github/typesafegithub/workflows/domain/Container;Lio/github/typesafegithub/workflows/domain/Environment;Ljava/util/Map;Ljava/util/Map;)V
public synthetic fun (Ljava/lang/String;Ljava/lang/String;Lio/github/typesafegithub/workflows/domain/RunnerType;Ljava/util/List;Ljava/util/List;Lio/github/typesafegithub/workflows/domain/JobOutputs;Ljava/util/Map;Ljava/lang/String;Ljava/util/Map;Ljava/util/Map;Ljava/lang/Integer;Lio/github/typesafegithub/workflows/domain/Concurrency;Lio/github/typesafegithub/workflows/domain/Container;Lio/github/typesafegithub/workflows/domain/Environment;Ljava/util/Map;Ljava/util/Map;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
@@ -520,7 +532,7 @@ public abstract class io/github/typesafegithub/workflows/domain/actions/Action {
public class io/github/typesafegithub/workflows/domain/actions/Action$Outputs {
public fun (Ljava/lang/String;)V
- public final fun get (Ljava/lang/String;)Ljava/lang/String;
+ public final fun get (Ljava/lang/String;)Lio/github/typesafegithub/workflows/domain/Expression;
}
public final class io/github/typesafegithub/workflows/domain/actions/CustomAction : io/github/typesafegithub/workflows/domain/actions/RegularAction {
diff --git a/github-workflows-kt/src/main/kotlin/io/github/typesafegithub/workflows/domain/Expression.kt b/github-workflows-kt/src/main/kotlin/io/github/typesafegithub/workflows/domain/Expression.kt
new file mode 100644
index 0000000000..a0ac3d758f
--- /dev/null
+++ b/github-workflows-kt/src/main/kotlin/io/github/typesafegithub/workflows/domain/Expression.kt
@@ -0,0 +1,9 @@
+package io.github.typesafegithub.workflows.domain
+
+import io.github.typesafegithub.workflows.dsl.expressions.expr
+
+public data class Expression(
+ public val expression: String,
+) {
+ public val expressionString: String = expr(expression)
+}
diff --git a/github-workflows-kt/src/main/kotlin/io/github/typesafegithub/workflows/domain/actions/Action.kt b/github-workflows-kt/src/main/kotlin/io/github/typesafegithub/workflows/domain/actions/Action.kt
index ff0d9d66c7..d8d6ad0f2c 100644
--- a/github-workflows-kt/src/main/kotlin/io/github/typesafegithub/workflows/domain/actions/Action.kt
+++ b/github-workflows-kt/src/main/kotlin/io/github/typesafegithub/workflows/domain/actions/Action.kt
@@ -1,5 +1,6 @@
package io.github.typesafegithub.workflows.domain.actions
+import io.github.typesafegithub.workflows.domain.Expression
import io.github.typesafegithub.workflows.domain.actions.Action.Outputs
import io.github.typesafegithub.workflows.yaml.toYaml
@@ -15,7 +16,7 @@ public abstract class Action {
public open class Outputs(
private val stepId: String,
) {
- public operator fun get(outputName: String): String = "steps.$stepId.outputs.$outputName"
+ public operator fun get(outputName: String): Expression = Expression("steps.$stepId.outputs.$outputName")
}
}
diff --git a/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/IntegrationTest.kt b/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/IntegrationTest.kt
index 28316995b6..a2dc98695b 100644
--- a/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/IntegrationTest.kt
+++ b/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/IntegrationTest.kt
@@ -262,7 +262,7 @@ class IntegrationTest :
Checkout(
repository = expr(addAndCommit.id),
ref = expr(addAndCommit.outputs.commitSha),
- token = expr(addAndCommit.outputs["my-unsafe-output"]),
+ token = addAndCommit.outputs["my-unsafe-output"].expressionString,
),
)
}
@@ -402,7 +402,7 @@ class IntegrationTest :
Checkout(
repository = expr(addAndCommit.id),
ref = expr(addAndCommit.outputs.commitSha),
- token = expr(addAndCommit.outputs["my-unsafe-output"]),
+ token = addAndCommit.outputs["my-unsafe-output"].expressionString,
),
)
}
diff --git a/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/actions/CustomActionTest.kt b/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/actions/CustomActionTest.kt
index a8b72b1192..2efeff4ba0 100644
--- a/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/actions/CustomActionTest.kt
+++ b/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/actions/CustomActionTest.kt
@@ -1,5 +1,6 @@
package io.github.typesafegithub.workflows.actions
+import io.github.typesafegithub.workflows.domain.Expression
import io.github.typesafegithub.workflows.domain.actions.CustomAction
import io.kotest.core.spec.style.FunSpec
import io.kotest.matchers.shouldBe
@@ -25,6 +26,6 @@ class CustomActionTest :
val outputs = customAction.buildOutputObject("someStepId")
// when & then
- outputs["custom-output"] shouldBe "steps.someStepId.outputs.custom-output"
+ outputs["custom-output"] shouldBe Expression("steps.someStepId.outputs.custom-output")
}
})
diff --git a/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/docsnippets/JobOutputsSnippets.kt b/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/docsnippets/JobOutputsSnippets.kt
index 1b49bbbf10..875733689c 100644
--- a/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/docsnippets/JobOutputsSnippets.kt
+++ b/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/docsnippets/JobOutputsSnippets.kt
@@ -59,7 +59,7 @@ class JobOutputsSnippets :
// --8<-- [start:set-job-outputs]
jobOutputs.myOutput = someStep.outputs.someStepOutput
- jobOutputs.anotherOutput = someStep.outputs["custom-output"]
+ jobOutputs.anotherOutput = someStep.outputs["custom-output"].expression
// --8<-- [end:set-job-outputs]
}
diff --git a/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/docsnippets/UsingActionsSnippets.kt b/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/docsnippets/UsingActionsSnippets.kt
index a3261aaf8d..45569d558c 100644
--- a/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/docsnippets/UsingActionsSnippets.kt
+++ b/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/docsnippets/UsingActionsSnippets.kt
@@ -9,7 +9,6 @@ import io.github.typesafegithub.workflows.domain.actions.DockerAction
import io.github.typesafegithub.workflows.domain.actions.LocalAction
import io.github.typesafegithub.workflows.domain.actions.RegularAction
import io.github.typesafegithub.workflows.domain.triggers.Push
-import io.github.typesafegithub.workflows.dsl.expressions.expr
import io.github.typesafegithub.workflows.dsl.workflow
import io.kotest.core.spec.style.FunSpec
import io.kotest.engine.spec.tempdir
@@ -136,7 +135,7 @@ class UsingActionsSnippets :
)
// use your outputs:
- println(expr(customActionStep.outputs["custom-output"]))
+ println(customActionStep.outputs["custom-output"].expressionString)
}
// --8<-- [end:custom-action-outputs]
}
diff --git a/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/domain/StepTest.kt b/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/domain/StepTest.kt
index c9d7086715..4f494329ed 100644
--- a/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/domain/StepTest.kt
+++ b/github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/domain/StepTest.kt
@@ -31,6 +31,6 @@ class StepTest :
}
test("step.outputs") {
val step0: Step<*> = CommandStep(id = "step-0", command = "ls")
- step0.outputs["foo"] shouldBe "steps.step-0.outputs.foo"
+ step0.outputs["foo"] shouldBe Expression("steps.step-0.outputs.foo")
}
})