feat: add check of compatibility between library version and binding

code-generator/src/main/kotlin/io/github/typesafegithub/workflows/VersionInfo.kt

@@ -0,0 +1,29 @@
+package io.github.typesafegithub.workflows
+
+import com.google.devtools.ksp.processing.CodeGenerator
+import com.squareup.kotlinpoet.CodeBlock
+import com.squareup.kotlinpoet.FileSpec
+import com.squareup.kotlinpoet.FunSpec
+import com.squareup.kotlinpoet.KModifier
+import com.squareup.kotlinpoet.ksp.writeTo
+
+fun generateVersionInfo(
+    codeGenerator: CodeGenerator,
+    libraryVersion: String,
+) {
+    val funSpec =
+        FunSpec
+            .builder(name = "getLibraryVersion")
+            .addModifiers(KModifier.INTERNAL)
+            .returns(String::class)
+            .addCode(CodeBlock.of("return \"$libraryVersion\""))
+            .build()
+
+    val fileSpec =
+        FileSpec
+            .builder(packageName = "io.github.typesafegithub.workflows.internal", fileName = "VersionInfo.kt")
+            .addFunction(funSpec)
+            .build()
+
+    fileSpec.writeTo(codeGenerator = codeGenerator, aggregating = false)
+}

code-generator/src/main/kotlin/io/github/typesafegithub/workflows/codegenerator/KspGenerator.kt

@@ -5,15 +5,18 @@ import com.google.devtools.ksp.processing.Resolver
 import com.google.devtools.ksp.processing.SymbolProcessor
 import com.google.devtools.ksp.symbol.KSAnnotated
 import io.github.typesafegithub.workflows.dsl.expressions.generateEventPayloads
+import io.github.typesafegithub.workflows.generateVersionInfo
 
 class KspGenerator(
     private val codeGenerator: CodeGenerator,
+    private val libraryVersion: String,
 ) : SymbolProcessor {
     private var wasRun = false
 
     override fun process(resolver: Resolver): List<KSAnnotated> {
         if (!wasRun) {
             generateEventPayloads(codeGenerator = codeGenerator)
+            generateVersionInfo(codeGenerator = codeGenerator, libraryVersion = libraryVersion)
             wasRun = true
         }
         return emptyList()

code-generator/src/main/kotlin/io/github/typesafegithub/workflows/codegenerator/KspGeneratorProvider.kt

@@ -8,5 +8,6 @@ class KspGeneratorProvider : SymbolProcessorProvider {
     override fun create(environment: SymbolProcessorEnvironment): SymbolProcessor =
         KspGenerator(
             codeGenerator = environment.codeGenerator,
+            libraryVersion = environment.options["library-version"] ?: error("No library version specified"),
         )
 }

github-workflows-kt/api/github-workflows-kt.api

@@ -518,6 +518,7 @@ public abstract class io/github/typesafegithub/workflows/domain/actions/Action {
 	public abstract fun buildOutputObject (Ljava/lang/String;)Lio/github/typesafegithub/workflows/domain/actions/Action$Outputs;
 	public abstract fun getUsesString ()Ljava/lang/String;
 	public final fun getYamlArgumentsString ()Ljava/lang/String;
+	public fun isCompatibleWithLibraryVersion (Ljava/lang/String;)Z
 	public abstract fun toYamlArguments ()Ljava/util/LinkedHashMap;
 }
 

github-workflows-kt/build.gradle.kts

@@ -62,6 +62,10 @@ kotlin {
     explicitApi()
 }
 
+ksp {
+    arg("library-version", project.version.toString())
+}
+
 fun ConfigurableKtLintTask.kotlinterConfig() {
     exclude { it.file.invariantSeparatorsPath.contains("/generated/") }
 }

github-workflows-kt/src/main/kotlin/io/github/typesafegithub/workflows/domain/Step.kt

@@ -4,6 +4,7 @@ import io.github.typesafegithub.workflows.domain.actions.Action
 import io.github.typesafegithub.workflows.domain.actions.Action.Outputs
 import io.github.typesafegithub.workflows.domain.contexts.Contexts
 import io.github.typesafegithub.workflows.dsl.HasCustomArguments
+import io.github.typesafegithub.workflows.internal.getLibraryVersion
 import kotlinx.serialization.Contextual
 
 @Suppress("LongParameterList")
@@ -88,4 +89,10 @@ public open class ActionStep<out OUTPUTS : Outputs>(
     ) {
     override val outputs: OUTPUTS
         get() = super.outputs
+
+    init {
+        assert(action.isCompatibleWithLibraryVersion(getLibraryVersion())) {
+            "This version of the library is not compatible with the provided action binding!"
+        }
+    }
 }

github-workflows-kt/src/main/kotlin/io/github/typesafegithub/workflows/domain/actions/Action.kt

@@ -12,6 +12,8 @@ public abstract class Action<out OUTPUTS : Outputs> {
 
     public abstract val usesString: String
 
+    public open fun isCompatibleWithLibraryVersion(libraryVersion: String): Boolean = true
+
     public open class Outputs(
         private val stepId: String,
     ) {

github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/domain/StepTest.kt

@@ -2,6 +2,8 @@ package io.github.typesafegithub.workflows.domain
 
 import io.github.typesafegithub.workflows.actions.actions.Checkout
 import io.github.typesafegithub.workflows.domain.AbstractResult.Status
+import io.github.typesafegithub.workflows.domain.actions.Action
+import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.matchers.shouldBe
 
@@ -31,4 +33,30 @@ class StepTest :
             val step0: Step<*> = CommandStep(id = "step-0", command = "ls")
             step0.outputs["foo"] shouldBe "steps.step-0.outputs.foo"
         }
+
+        test("incompatible library version with the binding") {
+            // Given
+            val incompatibleAction =
+                object : Action<Action.Outputs>() {
+                    override fun isCompatibleWithLibraryVersion(libraryVersion: String): Boolean = false
+
+                    override fun toYamlArguments(): LinkedHashMap<String, String> =
+                        throw NotImplementedError("Irrelevant for this test")
+
+                    override fun buildOutputObject(stepId: String): Outputs = Outputs(stepId)
+
+                    override val usesString: String
+                        get() = throw NotImplementedError("Irrelevant for this test")
+                }
+
+            // When
+            shouldThrow<AssertionError> {
+                ActionStep(
+                    id = "whatever",
+                    action = incompatibleAction,
+                )
+            }.also {
+                it.message shouldBe "This version of the library is not compatible with the provided action binding!"
+            }
+        }
     })