Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/typesafegithub/github-workflows-kt
Authoring GitHub Actions workflows in Kotlin. You won't go back to YAML!
https://github.com/typesafegithub/github-workflows-kt
dsl github github-actions kotlin kotlin-script library type-safe workflows
Last synced: 2 months ago
JSON representation
Authoring GitHub Actions workflows in Kotlin. You won't go back to YAML!
- Host: GitHub
- URL: https://github.com/typesafegithub/github-workflows-kt
- Owner: typesafegithub
- License: apache-2.0
- Created: 2021-12-18T17:05:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T08:14:19.000Z (3 months ago)
- Last Synced: 2024-10-29T09:31:31.009Z (3 months ago)
- Topics: dsl, github, github-actions, kotlin, kotlin-script, library, type-safe, workflows
- Language: Kotlin
- Homepage: https://typesafegithub.github.io/github-workflows-kt/
- Size: 18 MB
- Stars: 520
- Watchers: 8
- Forks: 24
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-github-repos - typesafegithub/github-workflows-kt - Authoring GitHub Actions workflows in Kotlin. You won't go back to YAML! (Kotlin)
- awesome-list - typesafegithub/github-workflows-kt - Authoring GitHub Actions workflows in Kotlin. You won't go back to YAML! (Kotlin)
README
[](https://maven-badges.herokuapp.com/maven-central/io.github.typesafegithub/github-workflows-kt)
[](https://github.com/KotlinBy/awesome-kotlin)
[](https://star-history.com/#typesafegithub/github-workflows-kt&Date)
[](https://github.com/typesafegithub/github-workflows-kt/blob/main/LICENSE)
[](https://kotlinlang.slack.com/archives/C02UUATR7RC)
[github-workflows-kt](https://github.com/typesafegithub/github-workflows-kt/) is a tool for generating
[GitHub Actions workflow](https://docs.github.com/en/actions/using-workflows) YAML files in a **type-safe** script, helping you to
build **robust** workflows for your GitHub projects without mistakes, with **pleasure**, in
[Kotlin](https://kotlinlang.org/).
> _You won't go back to YAML!_
### 💡 Idea
We're often surrounded by YAML configuration. It's a powerful format that provides simple syntax for defining
hierarchical data, but it is sometimes used (abused?) to configure complicated scenarios which leads to complicated
files 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 these
cases.
We're developing **github-workflows-kt** to solve these and other problems, so you can create GitHub Workflows with
confidence.
### ✨ Benefits
* **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 documentation
at your fingertips
* **no duplication** - don't repeat yourself! Share common configuration using constant values, or define your own
functions 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 with [github-actions-typing](https://github.com/typesafegithub/github-actions-typing) to use typings
provided by action authors
* [and more!](https://typesafegithub.github.io/github-workflows-kt/)
## For more info please see [the documentation](https://typesafegithub.github.io/github-workflows-kt/)
* [getting started](https://typesafegithub.github.io/github-workflows-kt/user-guide/getting_started/)
* [API docs](https://typesafegithub.github.io/github-workflows-kt/api-docs/)
* [how to contribute](https://github.com/typesafegithub/github-workflows-kt/blob/main/CONTRIBUTING.md)
