Skip to content

Commit 05942ab

Browse files
VampireVampire
committed
feat(abg): support different binding versions on different server routes
1 parent 2118339 commit 05942ab

File tree

10 files changed

+225
-31
lines changed

10 files changed

+225
-31
lines changed

‎.github/workflows/bindings-server.main.kts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,16 @@ workflow(
9191

9292
cleanMavenLocal()
9393

94+
run(
95+
name = "Execute the script using the bindings from the server with v1 route",
96+
command = """
97+
mv .github/workflows/test-script-consuming-jit-bindings-v1.main.do-not-compile.kts .github/workflows/test-script-consuming-jit-bindings-v1.main.kts
98+
.github/workflows/test-script-consuming-jit-bindings-v1.main.kts
99+
""".trimIndent(),
100+
)
101+
102+
cleanMavenLocal()
103+
94104
run(
95105
name = "Execute the script using bindings but without dependency on library",
96106
command = """

‎.github/workflows/bindings-server.yaml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,22 @@ jobs:
5757
name: 'Clean Maven Local to fetch required POMs again'
5858
run: 'rm -rf ~/.m2/repository/'
5959
- id: 'step-7'
60+
name: 'Execute the script using the bindings from the server with v1 route'
61+
run: |-
62+
mv .github/workflows/test-script-consuming-jit-bindings-v1.main.do-not-compile.kts .github/workflows/test-script-consuming-jit-bindings-v1.main.kts
63+
.github/workflows/test-script-consuming-jit-bindings-v1.main.kts
64+
- id: 'step-8'
65+
name: 'Clean Maven Local to fetch required POMs again'
66+
run: 'rm -rf ~/.m2/repository/'
67+
- id: 'step-9'
6068
name: 'Execute the script using bindings but without dependency on library'
6169
run: |-
6270
mv .github/workflows/test-served-bindings-depend-on-library.main.do-not-compile.kts .github/workflows/test-served-bindings-depend-on-library.main.kts
6371
.github/workflows/test-served-bindings-depend-on-library.main.kts
64-
- id: 'step-8'
72+
- id: 'step-10'
6573
name: 'Fetch maven-metadata.xml for top-level action'
6674
run: 'curl --fail http://localhost:8080/actions/checkout/maven-metadata.xml | grep ''<version>v4</version>'''
67-
- id: 'step-9'
75+
- id: 'step-11'
6876
name: 'Fetch maven-metadata.xml for nested action'
6977
run: 'curl --fail http://localhost:8080/actions/cache__save/maven-metadata.xml | grep ''<version>v4</version>'''
7078
deploy:

‎.github/workflows/test-script-consuming-jit-bindings-v1.main.do-not-compile.kts

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
#!/usr/bin/env kotlin
2+
@file:Repository("https://repo.maven.apache.org/maven2/")
3+
@file:DependsOn("io.github.typesafegithub:github-workflows-kt:1.13.0")
4+
5+
@file:Repository("http://localhost:8080/v1")
6+
7+
// Regular, top-level action.
8+
@file:DependsOn("actions:checkout:v4")
9+
10+
// Nested action.
11+
@file:DependsOn("gradle:actions__setup-gradle:v3")
12+
13+
// Using specific version.
14+
@file:DependsOn("actions:cache:v3.3.3")
15+
16+
// Always untyped action.
17+
@file:DependsOn("typesafegithub:always-untyped-action-for-tests:v1")
18+
19+
import io.github.typesafegithub.workflows.actions.actions.Cache
20+
import io.github.typesafegithub.workflows.actions.actions.Checkout
21+
import io.github.typesafegithub.workflows.actions.actions.Checkout_Untyped
22+
import io.github.typesafegithub.workflows.actions.gradle.ActionsSetupGradle
23+
import io.github.typesafegithub.workflows.actions.typesafegithub.AlwaysUntypedActionForTests_Untyped
24+
25+
println(Checkout_Untyped(fetchTags_Untyped = "false"))
26+
println(Checkout(fetchTags = false))
27+
println(Checkout(fetchTags_Untyped = "false"))
28+
println(AlwaysUntypedActionForTests_Untyped(foobar_Untyped = "baz"))
29+
println(ActionsSetupGradle())
30+
println(Cache(path = listOf("some-path"), key = "some-key"))
31+
32+
// Ensure that 'copy(...)' method is exposed.
33+
Checkout(fetchTags = false).copy(fetchTags = true)

‎action-binding-generator/api/action-binding-generator.api

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ public final class io/github/typesafegithub/workflows/actionbindinggenerator/gen
6969
}
7070

7171
public final class io/github/typesafegithub/workflows/actionbindinggenerator/generation/GenerationKt {
72-
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;
73-
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;
72+
public static final fun generateBinding (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionCoords;Lio/github/typesafegithub/workflows/actionbindinggenerator/versioning/BindingVersion;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/MetadataRevision;Lio/github/typesafegithub/workflows/actionbindinggenerator/metadata/Metadata;Lkotlin/Pair;)Ljava/util/List;
73+
public static synthetic fun generateBinding$default (Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/ActionCoords;Lio/github/typesafegithub/workflows/actionbindinggenerator/versioning/BindingVersion;Lio/github/typesafegithub/workflows/actionbindinggenerator/domain/MetadataRevision;Lio/github/typesafegithub/workflows/actionbindinggenerator/metadata/Metadata;Lkotlin/Pair;ILjava/lang/Object;)Ljava/util/List;
7474
}
7575

7676
public final class io/github/typesafegithub/workflows/actionbindinggenerator/metadata/Input {
@@ -179,3 +179,14 @@ public final class io/github/typesafegithub/workflows/actionbindinggenerator/met
179179
public abstract interface class io/github/typesafegithub/workflows/actionbindinggenerator/typing/Typing {
180180
}
181181

182+
public final class io/github/typesafegithub/workflows/actionbindinggenerator/versioning/BindingVersion : java/lang/Enum {
183+
public static final field V1 Lio/github/typesafegithub/workflows/actionbindinggenerator/versioning/BindingVersion;
184+
public static fun getEntries ()Lkotlin/enums/EnumEntries;
185+
public final fun getLibraryVersion ()Ljava/lang/String;
186+
public final fun isDeprecated ()Z
187+
public final fun isExperimental ()Z
188+
public fun toString ()Ljava/lang/String;
189+
public static fun valueOf (Ljava/lang/String;)Lio/github/typesafegithub/workflows/actionbindinggenerator/versioning/BindingVersion;
190+
public static fun values ()[Lio/github/typesafegithub/workflows/actionbindinggenerator/versioning/BindingVersion;
191+
}
192+

‎action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/generation/Generation.kt

Lines changed: 85 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@ import com.squareup.kotlinpoet.PropertySpec
1414
import com.squareup.kotlinpoet.TypeSpec
1515
import com.squareup.kotlinpoet.asClassName
1616
import com.squareup.kotlinpoet.asTypeName
17+
import com.squareup.kotlinpoet.buildCodeBlock
1718
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
1819
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.MetadataRevision
1920
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.TypingActualSource
21+
import io.github.typesafegithub.workflows.actionbindinggenerator.domain.prettyPrint
2022
import io.github.typesafegithub.workflows.actionbindinggenerator.generation.Properties.CUSTOM_INPUTS
2123
import io.github.typesafegithub.workflows.actionbindinggenerator.generation.Properties.CUSTOM_VERSION
2224
import io.github.typesafegithub.workflows.actionbindinggenerator.metadata.Input
@@ -32,6 +34,8 @@ import io.github.typesafegithub.workflows.actionbindinggenerator.typing.provideT
3234
import io.github.typesafegithub.workflows.actionbindinggenerator.utils.removeTrailingWhitespacesForEachLine
3335
import io.github.typesafegithub.workflows.actionbindinggenerator.utils.toCamelCase
3436
import io.github.typesafegithub.workflows.actionbindinggenerator.utils.toKotlinPackageName
37+
import io.github.typesafegithub.workflows.actionbindinggenerator.versioning.BindingVersion
38+
import io.github.typesafegithub.workflows.actionbindinggenerator.versioning.BindingVersion.V1
3539

3640
public data class ActionBinding(
3741
val kotlinCode: String,
@@ -54,6 +58,7 @@ private object Properties {
5458
}
5559

5660
public fun ActionCoords.generateBinding(
61+
bindingVersion: BindingVersion = V1,
5762
metadataRevision: MetadataRevision,
5863
metadata: Metadata? = null,
5964
inputTypings: Pair<Map<String, Typing>, TypingActualSource?>? = null,
@@ -69,10 +74,11 @@ public fun ActionCoords.generateBinding(
6974

7075
val actionBindingSourceCodeUntyped =
7176
generateActionBindingSourceCode(
72-
metadataProcessed,
73-
this,
74-
emptyMap(),
75-
classNameUntyped,
77+
metadata = metadataProcessed,
78+
coords = this,
79+
bindingVersion = bindingVersion,
80+
inputTypings = emptyMap(),
81+
className = classNameUntyped,
7682
untypedClass = true,
7783
replaceWith = inputTypingsResolved.second?.let { CodeBlock.of("ReplaceWith(%S)", className) },
7884
)
@@ -90,6 +96,7 @@ public fun ActionCoords.generateBinding(
9096
generateActionBindingSourceCode(
9197
metadata = metadataProcessed,
9298
coords = this,
99+
bindingVersion = bindingVersion,
93100
inputTypings = inputTypingsResolved.first,
94101
className = className,
95102
)
@@ -120,6 +127,7 @@ private fun Metadata.removeDeprecatedInputsIfNameClash(): Metadata {
120127
private fun generateActionBindingSourceCode(
121128
metadata: Metadata,
122129
coords: ActionCoords,
130+
bindingVersion: BindingVersion,
123131
inputTypings: Map<String, Typing>,
124132
className: String,
125133
untypedClass: Boolean = false,
@@ -136,7 +144,7 @@ private fun generateActionBindingSourceCode(
136144
changes will be overwritten with the next binding code regeneration.
137145
See https://github.com/typesafegithub/github-workflows-kt for more info.
138146
""".trimIndent(),
139-
).addType(generateActionClass(metadata, coords, inputTypings, className, untypedClass, replaceWith))
147+
).addType(generateActionClass(metadata, coords, bindingVersion, inputTypings, className, untypedClass, replaceWith))
140148
.addSuppressAnnotation(metadata)
141149
.indent(" ")
142150
.build()
@@ -165,6 +173,7 @@ private fun FileSpec.Builder.addSuppressAnnotation(metadata: Metadata) =
165173
private fun generateActionClass(
166174
metadata: Metadata,
167175
coords: ActionCoords,
176+
bindingVersion: BindingVersion,
168177
inputTypings: Map<String, Typing>,
169178
className: String,
170179
untypedClass: Boolean,
@@ -174,12 +183,13 @@ private fun generateActionClass(
174183
.classBuilder(className)
175184
.addModifiers(KModifier.DATA)
176185
.addKdocIfNotEmpty(actionKdoc(metadata, coords, untypedClass))
177-
.replaceWith(replaceWith)
186+
.deprecateBindingVersion(bindingVersion)
187+
.replaceWith(bindingVersion, replaceWith)
178188
.addClassConstructorAnnotation()
179189
.inheritsFromRegularAction(coords, metadata, className)
180190
.primaryConstructor(metadata.primaryConstructor(inputTypings, coords, className, untypedClass))
181191
.properties(metadata, coords, inputTypings, className, untypedClass)
182-
.addInitializerBlockIfNecessary(metadata, inputTypings, untypedClass)
192+
.addInitializerBlock(metadata, bindingVersion, coords, inputTypings, untypedClass)
183193
.addFunction(metadata.secondaryConstructor(inputTypings, coords, className, untypedClass))
184194
.addFunction(metadata.buildToYamlArgumentsFunction(inputTypings, untypedClass))
185195
.addCustomTypes(inputTypings, coords, className)
@@ -374,8 +384,23 @@ private fun Metadata.linkedMapOfInputs(
374384
}
375385
}
376386

377-
private fun TypeSpec.Builder.replaceWith(replaceWith: CodeBlock?): TypeSpec.Builder {
378-
if (replaceWith != null) {
387+
private fun TypeSpec.Builder.deprecateBindingVersion(bindingVersion: BindingVersion): TypeSpec.Builder {
388+
if (bindingVersion.isDeprecated) {
389+
addAnnotation(
390+
AnnotationSpec
391+
.builder(Deprecated::class.asClassName())
392+
.addMember("%S", "Use a non-deprecated binding version in the repository URL")
393+
.build(),
394+
)
395+
}
396+
return this
397+
}
398+
399+
private fun TypeSpec.Builder.replaceWith(
400+
bindingVersion: BindingVersion,
401+
replaceWith: CodeBlock?,
402+
): TypeSpec.Builder {
403+
if (!bindingVersion.isDeprecated && replaceWith != null) {
379404
addAnnotation(
380405
AnnotationSpec
381406
.builder(Deprecated::class.asClassName())
@@ -533,15 +558,63 @@ private fun ParameterSpec.Builder.defaultValueIfNullable(
533558
return this
534559
}
535560

536-
private fun TypeSpec.Builder.addInitializerBlockIfNecessary(
561+
private fun TypeSpec.Builder.addInitializerBlock(
537562
metadata: Metadata,
563+
bindingVersion: BindingVersion,
564+
coords: ActionCoords,
538565
inputTypings: Map<String, Typing>,
539566
untypedClass: Boolean,
540567
): TypeSpec.Builder {
541-
if (untypedClass || metadata.inputs.isEmpty() || metadata.inputs.none { inputTypings.containsKey(it.key) }) {
568+
if (!bindingVersion.isDeprecated &&
569+
!bindingVersion.isExperimental &&
570+
(untypedClass || metadata.inputs.isEmpty() || metadata.inputs.none { inputTypings.containsKey(it.key) })
571+
) {
542572
return this
543573
}
544-
addInitializerBlock(metadata.initializerBlock(inputTypings))
574+
575+
addInitializerBlock(
576+
buildCodeBlock {
577+
if (bindingVersion.isDeprecated) {
578+
val firstStableVersion = BindingVersion.entries.find { !it.isDeprecated && !it.isExperimental }
579+
addStatement(
580+
"println(%S)",
581+
"""
582+
WARNING: The used binding version $bindingVersion for ${coords.prettyPrint} is deprecated! First stable version is $firstStableVersion.
583+
""".trimIndent(),
584+
)
585+
beginControlFlow("""if (System.getenv("GITHUB_ACTIONS").toBoolean())""")
586+
addStatement(
587+
"println(%S)",
588+
"""
589+
590+
::warning title=Deprecated Binding Version Used::The used binding version $bindingVersion for ${coords.prettyPrint} is deprecated! First stable version is $firstStableVersion.
591+
""".trimIndent(),
592+
)
593+
endControlFlow()
594+
add("\n")
595+
}
596+
if (bindingVersion.isExperimental) {
597+
val lastStableVersion = BindingVersion.entries.findLast { !it.isDeprecated && !it.isExperimental }
598+
addStatement(
599+
"println(%S)",
600+
"""
601+
WARNING: The used binding version $bindingVersion for ${coords.prettyPrint} is experimental! Last stable version is $lastStableVersion.
602+
""".trimIndent(),
603+
)
604+
beginControlFlow("""if (System.getenv("GITHUB_ACTIONS").toBoolean())""")
605+
addStatement(
606+
"println(%S)",
607+
"""
608+
609+
::warning title=Experimental Binding Version Used::The used binding version $bindingVersion for ${coords.prettyPrint} is experimental! Last stable version is $lastStableVersion.
610+
""".trimIndent(),
611+
)
612+
endControlFlow()
613+
add("\n")
614+
}
615+
add(metadata.initializerBlock(inputTypings))
616+
},
617+
)
545618
return this
546619
}
547620

‎action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/versioning/BindingVersion.kt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package io.github.typesafegithub.workflows.actionbindinggenerator.versioning
2+
3+
public enum class BindingVersion(
4+
public val isDeprecated: Boolean = false,
5+
public val isExperimental: Boolean = true,
6+
public val libraryVersion: String,
7+
) {
8+
V1(isExperimental = false, libraryVersion = "3.0.0"),
9+
;
10+
11+
override fun toString(): String = super.toString().lowercase()
12+
}

0 commit comments

Comments
 (0)