Repository files navigation

github-workflows-kt is a tool for generatingGitHub Actions workflow YAML files in atype-safe script, helping you tobuildrobust workflows for your GitHub projects without mistakes, withpleasure, inKotlin.

You won't go back to YAML!

We're often surrounded by YAML configuration. It's a powerful format that provides simple syntax for defininghierarchical data, but it is sometimes used (abused?) to configure complicated scenarios which leads to complicatedfiles that are difficult to write and maintain.

Who among us hasn't accidentally used the wrong indentation, missed a possibility to extract a reusable piece of code,or been confused by ambiguous types? The power of a generic-purpose programming language would come in handy in thesecases.

We're developinggithub-workflows-kt to solve these and other problems, so you can create GitHub Workflows withconfidence.

• no indentation confusion - Kotlin's syntax doesn't rely on it
• immediate validation - catch bugs early during development, not during runtime
• strongly typed values - no more confusion about what type is needed for a given parameter
• superb IDE support - author your workflows in any IDE that supports Kotlin, with auto-completion and documentationat your fingertips
• no duplication - don't repeat yourself! Share common configuration using constant values, or define your ownfunctions to encapsulate logic
• fully featured language - use the full power of Kotlin to generate workflows dynamically, randomly generate data,or add custom validation. Defining workflow logic in Kotlin is currently experimental
• type-safe action bindings - possible to use every action using auto-generated Kotlin bindings
• integrates withgithub-actions-typing to use typingsprovided by action authors
• and more!

• getting started
• API docs
• how to contribute