3.1.0

⭐ Features

• allow fallback to local bindings server in consistency check job
• add prefixes to step names for fallback path

This release focuses on adding a way to mitigate the binding server's availability issues, if they ever reoccur. This opt-in feature can be used in the following way:

consistencyCheckJobConfig = DEFAULT_CONSISTENCY_CHECK_JOB_CONFIG.copy(
    useLocalBindingsServerAsFallback = true,
),

which will result in adding an alternative path to your consistency check jobs that will be triggered if the original consistency check fails on compiling the script. Enabling this option costs you nothing in terms of extra CI time, if the server is up. If the server is down, it's usually an extra half a minute to up the server and rerun the workflow script.

Example:

🛠️ Fixes

None.

💣 Breaking changes

None.

📦 Dependencies

• update dependency it.krzeminski:snakeyaml-engine-kmp to v3.1.0
• update dependency org.jetbrains.kotlinx:kotlinx-serialization-core to v1.8.0
• update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.8.0

---

The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full change log: v3.0.2...v3.1.0

3.0.2

⭐ Features

None.

🛠️ Fixes

None.

💣 Breaking changes

None.

📦 Dependencies

• update Kotlin to v2.1.0
• update it.krzeminski:snakeyaml-engine-kmp to v3.0.3

---

The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full change log: v3.0.1...v3.0.2

3.0.1

This release is mainly to deploy changes in the docs.

⭐ Features

None.

🛠️ Fixes

None.

💣 Breaking changes

None.

📦 Dependencies

• update Kotlin to 2.0.21
• update kotlinx.serialization to 1.7.3

---

The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full change log: v3.0.0...v3.0.1

3.0.0

⭐ Features

• add RepositoryDispatch.types
• make outputs accessible for all steps (thanks @Vampire!)
• support getting uses string and YAML arguments as string (thanks @Vampire!)

🛠️ Fixes

💣 Breaking changes

• remove bundled action bindings - see the migration guide: https://typesafegithub.github.io/github-workflows-kt/user-guide/migrating-to-Maven-based-bindings/
• do not return Workflow from workflow builder - from now on, use useWorkflow parameter of workflow function
• make outputs accessible for all steps - you may need to replace Step with e.g. Step<*> or a particular type

---

The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full change log: v2.3.0...v3.0.0

2.3.0

⭐ Features

• allow providing callback to use workflow object
  • the workflow function won't return the Workflow object starting from v3, and this feature provides the new API for using the Workflow domain object

🛠️ Fixes

None.

💣 Breaking changes

None.

▶️ Actions

Warning

This is the last release with bundled bindings. The next release is going to be 3.0.0, with the bundled bindings removed, together with this section of the release notes. Please switch to Maven-based bindings server, see Migrating to Maven-based bindings

• add madhead/intellij-http-client-action@v241
• update ReactiveCircus/android-emulator-runner@v2
• update julia-actions/setup-julia@v2
• update aws-actions/amazon-ecs-render-task-definition@v1

---

The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full change log: v2.2.0...v2.3.0

2.2.0

⭐ Features

None.

🛠️ Fixes

None.

💣 Breaking changes

None.

▶️ Actions

• add docker/build-push-action@v6
• update peter-evans/create-pull-request@v6
• update gradle/gradle-build-action@v3

---

The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full change log: v2.1.1...v2.2.0

2.1.1

No changes in the library itself.

An internal release, to update the docs and let you know that we're changing the URL for the action bindngs server (more context on this feature here) - please update your scripts:

- @file:Repository("https://github-workflows-kt-bindings.colman.com.br/binding/")
+ @file:Repository("https://bindings.krzeminski.it/")

The old URL (https://github-workflows-kt-bindings.colman.com.br/binding/) will still work until the end of August 2024.

Slack thread: https://kotlinlang.slack.com/archives/C02UUATR7RC/p1718314294799469

---

The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full change log: v2.1.0...v2.1.1

2.1.0

⭐ Features

• allow writing workflow to string

🛠️ Fixes

• support serializing Double (thanks @haifengkao!)

💣 Breaking changes

None.

▶️ Actions

• add Azure/docker-login@v2
• update Vampire/setup-wsl@v3
• update gautamkrishnar/blog-post-workflow@v1

---

The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full change log: v2.0.0...v2.1.0

2.0.0

⭐ Features

• default to null url for environment
• accept maps and sets instead of linked versions

📄 Docs

• adjust Maven bindings migration guide to API changes

🛠️ Fixes

None.

💣 Breaking changes

• write to file in workflow builder
  • how to adjust: remove the .writeToFile(...), and move all its arguments to the workflow(...) call
• change type of sourceFile to File
  • how to adjust: remove .toPath()
• restructure API for configuring YAML consistency check job
  • how to adjust: see the fields of the new consistencyCheckJobConfig argument (of type ConsistencyCheckJobConfig), you can also build on top of DEFAULT_CONSISTENCY_CHECK_JOB_CONFIG by calling .copy(...) on it. If you don't want the consistency check job, use consistencyCheckJobConfig = ConsistencyCheckJobConfig.Disabled
• remove toYaml()
  • this use case won't be supported by design anymore - the library is in charge of creating and writing the YAML. If you need to tinker with YAML before it's written to a file, please create an issue describing your use case

▶️ Actions

• add cachix/install-nix-action@v27
• update aws-actions/amazon-ecs-render-task-definition@v1
• update aws-actions/amazon-ecs-deploy-task-definition@v1
• update google-github-actions/auth@v2

---

The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full changelog: v1.15.0...v2.0.0

1.15.0

⭐ Features

• add environment to job
• allow setting output in Kotlin-based step
• add module with version update notifications (thanks @NikkyAI!)
• allow specifying Kotlin step's condition in Kotlin
• allow specifying env vars for consistency check jo (thanks @NikkyAI!)
• allow adding extra steps in consistency check job (thanks @NikkyAI!)
• serve artifacts for specific versions - the Maven-based bindings server now also supports referring to versions by the full version, i.e. v1.2.3
• 🧪 provide minimal github context in Kotlin logic step

📄 Docs

None.

🛠️ Fixes

None.

💣 Breaking changes

• remove leftover API for client-side bindings generation

▶️ Actions

• add gradle/wrapper-validation-action@v3
• update gradle/gradle-build-action@v3
• update actions/checkout@v4

---

The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full changelog: v1.14.0...v1.15.0