feat(library): add the vars context (#1961)

Fixes #1955

Author: Vampire

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

@@ -1978,6 +1978,7 @@ public final class io/github/typesafegithub/workflows/dsl/expressions/Contexts :
 	public final fun getGithub ()Lio/github/typesafegithub/workflows/dsl/expressions/contexts/GitHubContext;
 	public final fun getRunner ()Lio/github/typesafegithub/workflows/dsl/expressions/contexts/RunnerContext;
 	public final fun getSecrets ()Lio/github/typesafegithub/workflows/dsl/expressions/contexts/SecretsContext;
+	public final fun getVars ()Lio/github/typesafegithub/workflows/dsl/expressions/contexts/VarsContext;
 }
 
 public class io/github/typesafegithub/workflows/dsl/expressions/ExpressionContext : java/util/Map, kotlin/jvm/internal/markers/KMappedMarker {
@@ -3021,6 +3022,10 @@ public final class io/github/typesafegithub/workflows/dsl/expressions/contexts/S
 	public final fun getGITHUB_TOKEN ()Ljava/lang/String;
 }
 
+public final class io/github/typesafegithub/workflows/dsl/expressions/contexts/VarsContext : io/github/typesafegithub/workflows/dsl/expressions/ExpressionContext {
+	public static final field INSTANCE Lio/github/typesafegithub/workflows/dsl/expressions/contexts/VarsContext;
+}
+
 public final class io/github/typesafegithub/workflows/dsl/expressions/contexts/WorkflowDispatchEvent {
 	public static final field INSTANCE Lio/github/typesafegithub/workflows/dsl/expressions/contexts/WorkflowDispatchEvent;
 	public static final field ref Ljava/lang/String;

github-workflows-kt/src/main/kotlin/io/github/typesafegithub/workflows/dsl/expressions/Contexts.kt

@@ -5,6 +5,7 @@ import io.github.typesafegithub.workflows.dsl.expressions.contexts.FunctionsCont
 import io.github.typesafegithub.workflows.dsl.expressions.contexts.GitHubContext
 import io.github.typesafegithub.workflows.dsl.expressions.contexts.RunnerContext
 import io.github.typesafegithub.workflows.dsl.expressions.contexts.SecretsContext
+import io.github.typesafegithub.workflows.dsl.expressions.contexts.VarsContext
 
 /**
  * Root elements of GitHub expressions.
@@ -17,4 +18,5 @@ public object Contexts : FunctionsContext() {
     public val github: GitHubContext = GitHubContext
     public val runner: RunnerContext = RunnerContext
     public val secrets: SecretsContext = SecretsContext
+    public val vars: VarsContext = VarsContext
 }

github-workflows-kt/src/main/kotlin/io/github/typesafegithub/workflows/dsl/expressions/contexts/VarsContext.kt

@@ -0,0 +1,12 @@
+package io.github.typesafegithub.workflows.dsl.expressions.contexts
+
+import io.github.typesafegithub.workflows.dsl.expressions.ExpressionContext
+
+/**
+ * Vars
+ *
+ * Vars allow you to store configuration variables in your organization, repository, or repository environments.
+ *
+ * https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#vars-context
+ */
+public object VarsContext : ExpressionContext("vars")

github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/docsnippets/TypeSafeExpressionsSnippets.kt

@@ -103,4 +103,23 @@ class TypeSafeExpressionsSnippets :
                 // --8<-- [end:secrets]
             }
         }
+
+        test("vars") {
+            workflow(
+                name = "Test workflow",
+                on = listOf(Push()),
+                sourceFile = sourceTempFile,
+            ) {
+                // --8<-- [start:secrets]
+                val SOME_VARIABLE by Contexts.vars
+
+                job(id = "job1", runsOn = RunnerType.UbuntuLatest) {
+                    run(
+                        name = "Some Variable",
+                        command = "echo someVariable=${expr { SOME_VARIABLE }}",
+                    )
+                }
+                // --8<-- [end:secrets]
+            }
+        }
     })

github-workflows-kt/src/test/kotlin/io/github/typesafegithub/workflows/dsl/expressions/ContextsTest.kt

@@ -33,6 +33,13 @@ class ContextsTest :
             }
         }
 
+        test("Vars") {
+            assertSoftly {
+                val SOME_VARIABLE by Contexts.vars
+                expr { SOME_VARIABLE } shouldBe expr("vars.SOME_VARIABLE")
+            }
+        }
+
         test("Runner context") {
             assertSoftly {
                 expr { runner.name } shouldBe expr("runner.name")