Releases: typesafegithub/github-workflows-kt
Release list
3.7.0
⭐ Features
- allow specifying checkout action's version in consistency check job
- thanks to an opt-in feature of using the version from classpath, updating a version in Maven artifact representing the actions/checkout action will result in the consistency check job reusing this version. In particular, it means that Renovate can bump actions/checkout without any manual fixing or reverting the version in the consistency check job!
- how to opt in - example: typesafegithub/github-actions-typing-catalog@746f9d5
🛠️ Fixes
None.
💣 Breaking changes
None.
📦 Dependencies
None.
The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full change log: v3.6.0...v3.7.0
3.6.0
⭐ Features
🛠️ Fixes
None.
💣 Breaking changes
None.
📦 Dependencies
The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full change log: v3.5.0...v3.6.0
3.5.0
⭐ Features
- add the vars context (thanks @Vampire!)
- add check of compatibility between library version and binding
🛠️ Fixes
None.
💣 Breaking changes
None.
📦 Dependencies
- update kotlin monorepo to v2.2.0
- update dependency org.jetbrains.kotlinx:kotlinx-serialization-core to v1.9.0
- update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.9.0
The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full change log: v3.4.0...v3.5.0
Contributors
Assets 2
3.4.0
⭐ Features
🛠️ Fixes
💣 Breaking changes
None.
📦 Dependencies
- update dependency org.jetbrains.kotlinx:kotlinx-serialization-core to v1.8.1
- update dependency org.jetbrains.kotlinx:kotlinx-serialization-json to v1.8.1
The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full change log: v3.3.0...v3.4.0
3.3.0
⭐ Features
None.
🛠️ Fixes
💣 Breaking changes
- allow running Kotlin-based step if multiple workflows in single file
- breaking only if you use the experimental feature of Kotlin-based steps
📦 Dependencies
The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full change log: v3.2.0...v3.3.0
3.2.0
⭐ Features
- allow setting custom step ID
- add 'type' argument to Release trigger
- allow building ActionStep outside of job
- add properties to WorkflowCall trigger
- add 'number' as input type of WorkflowDispatch
🛠️ Fixes
None.
💣 Breaking changes
Some of the above features in very rare contexts may be breaking.
📦 Dependencies
None.
The above release notes include customer-facing changes.
If you're interested also in internal changes, please see the full change log: v3.1.0...v3.2.0
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
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
useWorkflowparameter ofworkflowfunction - make outputs accessible for all steps - you may need to replace
Stepwith 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