Work in progress!
The goal is to be able to describe GH Actions in Kotlin with all its perks, like:
workflow(
name = "Test workflow",
on = listOf(Push),
) {
job(
name = "test_job",
runsOn = UbuntuLatest,
) {
uses(action = "actions/checkout@v2")
run(
name = "Hello world!",
run = "echo 'hello!'")
}
}
Hi, I thought I'd make a PR directly rather than an issue - I hope that's okay.
I noticed the Gradle build files had some repetition that could be tidied up by using buildSrc convention plugins.
I also tidied up some of the Gradle task definitions.
To help me work with the existing style I added a simple Editor Config file.
If accepted, here are some notes on how to develop in the future:
./buildSrc/build.gradle.kts./buildSrc/build.gradle.kts./buildSrc/repositories.settings.gradle.ktskotlin-jvm.gradle.kts buildSrc plugin. To change a setting for one subproject, change it in that subprojectThe versions of dependencies could be defined in one place using the 'Java Platform' plugin and/or using a version catalog - I can implement this if you'd like!
Currently the library contains logic for serializing to YAML in multiple places. Besides mixing layers (business logic vs serialization), this is error-prone because e.g. fixing an issue in one place may lead to not fixing it in other relevant contexts.
Here's a list of problems that appeared because of incorrect YAML serialization:
Currently it's challenging to add support for multiple new actions. Each new action requires checking its inputs and inferring their types which then land in WrappersToGenerate.kt. Sometimes they are provided by the authors in README, sometimes they are inferred from input's description or type of default value. It doesn't scale well, introduces a risk of human error and adds operational load for actions already supported if they get new inputs.
We should encourage action owners to proactively provide types for their actions' APIs in a standardized manner. The proposed approach is to have a GitHub action that would read action's manifest (action.y(a)ml) and would validate an extra type attribute for each input and output. This DSL library currently generates type-safe API only for inputs, but in the future the outputs can be type-safe as well.
Once such approach becomes popular, an automated job could proactively scan GitHub for actions using the typing validation action mentioned above, and add it to the list of requested wrappers. In the future, once Kotlin compiler plugins are easier to use from Kotlin scripting, I can imagine generating necessary wrapper code using such plugin, which would remove the need to maintain wrappers code in the library.
enhancementsee #129
the minimal way to call workflow is now with arguments like so
workflow(
name = "...",
on = listOf()
sourceFile = __FILE__,
) {
...
}
optional arguments are
rootDir, by default finds the first folder up the filetree that contains a .git foldertargetFolder, by default $gitRootFolder/.github/workflows/targetFileName by default the basename of the script + .yml (eg. build.main.kts -> build.yml)usage sample: https://github.com/NikkyAI/twitch-announcement-discord-bot/blob/main/.github/workflows/docker_workflow.main.kts
Allow setting arbitrary workflow/job/step attribute via withFreeArgs(...)
https://github.com/krzema12/github-actions-kotlin-dsl/issues/99
![[#99] Allow setting arbitrary workflow/job/step attribute](https://avatars.githubusercontent.com/u/459464?v=4)
val action = CheckoutV2(
repository = "repository",
ref = "main",
).withFreeArgs(
"hello" to "world",
"repository" to "jcenter",
"groceries" to listOf("cheese", "wine"),
)
val trigger = PullRequest().withFreeArgs(
"types" to listOf("ignored"),
"lang" to "french",
"list" to listOf(1, 2, 3)
)
val workflow = workflow(
) {
job(
name = "test_job",
runsOn = RunnerType.UbuntuLatest,
) {
}.withFreeArgs(
"distribute-job" to true,
"servers" to listOf("server-1", "server-2")
)
}.withFreeArgs(
"dry-run" to true,
"written-by" to listOf("Alice", "Bob")
)
It's usually not needed, and needlessly consumes shared resources. The jobs are usually needed only for the original repo since they help keeping the action wrappers up-to-date.
bugSee https://github.com/krzema12/github-actions-kotlin-dsl/actions/workflows/Integration%20tests%20-%20type-safe%20expressions.yaml
The workflow is not valid. .github/workflows/Integration tests - type-safe expressions.yaml (Line: 26, Col: 14): Unexpected symbol: '$GREETING'. Located at position 1 within expression: $GREETING
There wasn't a single successful run. I noticed it by accident. It doesn't produce a failed run within e. g. a PR which is a real bummer.
FYI @jmfayard
bughttps://github.com/krzema12/github-actions-kotlin-dsl/blob/982b225bc2c456962b9280da86f19068a64d61b0/.github/workflows/check-if-wrappers-up-to-date.main.kts#L21-L23
See the PullRequest and WorkflowDispatch triggers, they have no arguments which produces {} in YAML:
https://github.com/krzema12/github-actions-kotlin-dsl/blob/982b225bc2c456962b9280da86f19068a64d61b0/.github/workflows/check-if-wrappers-up-to-date.yaml#L10-L14
Apparently snakeyaml thinks it can optimize stuff by putting {} under an alias.
A working workflow, in this case: without the aliases and anchors.
https://github.com/krzema12/github-actions-kotlin-dsl/actions/runs/2885270912
The workflow is not valid. .github/workflows/check-if-wrappers-up-to-date.yaml: Anchors are not currently supported. Remove the anchor 'id001'
Try to adjust your code so that there are no repeated objects. Example: https://github.com/krzema12/github-actions-kotlin-dsl/commit/fc98b5c52a473b1097659a4dd8cf97356f3b796d
v0.25.0
bugWhat feature do you need?
defaults parameter for workflows and jobs.
Do you have an example usage?
![[Core feature request] Defaults Parameters](https://avatars.githubusercontent.com/u/21369551?v=4)
defaults:
run:
shell: bash
working-directory: scripts
Is there a workaround for not having this feature? If yes, please describe it. The custom arguments for either workflows or jobs do not work in this case since its a nested map and custom arguments only support one level of nesting at the moment.
enhancement questionResolves #203
What
type-safe expressions
How
see tests
what's missing
ActionWithOutputsDoc
There are lists of most popular actions, e.g.: https://codecov.wordpress.com/2020/09/14/most-popular-and-used-github-actions/ The goal here is to proactively add them so that there's higher chance that new users of this library can use it without adding new wrappers.
List of wrappers to add, updated so that already added wrappers are removed: https://gist.github.com/krzema12/59de5c0508dac8f5d1d27d00de38a06e
enhancementNo, it's not supported yet
Read more about them: https://fly.io/docs/app-guides/continuous-deployment-with-github-actions
Note that this action is not using the default and recommended project layout. I.e. they have action.yml in a subdirectory.
Thus, I was not able to quickly make the generator (./gradlew :wrapper-generator:run) work generate anything for it. I got either
![[Action wrapper(s) request] superfly/flyctl-actions/setup-flyctl@master](https://avatars.githubusercontent.com/u/577360?v=4)
Generating superfly/flyctl-actions@setup-flyctl
Exception in thread "main" java.lang.IllegalArgumentException: Only major versions are supported, and 'setup-flyctl' was given!
at it.krzeminski.githubactions.wrappergenerator.generation.GenerationKt.generateWrapper(Generation.kt:48)
at it.krzeminski.githubactions.wrappergenerator.generation.GenerationKt.generateWrapper$default(Generation.kt:44)
at it.krzeminski.githubactions.wrappergenerator.GenerationEntryPointKt.generateWrappers(GenerationEntryPoint.kt:39)
at it.krzeminski.githubactions.wrappergenerator.GenerationEntryPointKt.main(GenerationEntryPoint.kt:28)
at it.krzeminski.githubactions.wrappergenerator.GenerationEntryPointKt.main(GenerationEntryPoint.kt)
or
Generating flyctl-actions/setup-flyctl@v1
... from https://raw.githubusercontent.com/flyctl-actions/setup-flyctl/dbf1fa04f4d2e52c33185153d06cdb5443aa189d/action.yml
... from https://raw.githubusercontent.com/flyctl-actions/setup-flyctl/dbf1fa04f4d2e52c33185153d06cdb5443aa189d/action.yaml
Exception in thread "main" java.lang.IllegalStateException: flyctl-actions/setup-flyctl@v1
†Can't fetch any of those URLs:
- https://raw.githubusercontent.com/flyctl-actions/setup-flyctl/dbf1fa04f4d2e52c33185153d06cdb5443aa189d/action.yml
- https://raw.githubusercontent.com/flyctl-actions/setup-flyctl/dbf1fa04f4d2e52c33185153d06cdb5443aa189d/action.yaml
Check release page https://github.com/flyctl-actions/setup-flyctl/releases
at it.krzeminski.githubactions.wrappergenerator.metadata.MetadataReadingKt.fetchMetadata(MetadataReading.kt:64)
at it.krzeminski.githubactions.wrappergenerator.metadata.MetadataReadingKt.fetchMetadata$default(MetadataReading.kt:48)
at it.krzeminski.githubactions.wrappergenerator.generation.GenerationKt$generateWrapper$1.invoke(Generation.kt:46)
at it.krzeminski.githubactions.wrappergenerator.generation.GenerationKt$generateWrapper$1.invoke(Generation.kt:46)
at it.krzeminski.githubactions.wrappergenerator.generation.GenerationKt.generateWrapper(Generation.kt:52)
at it.krzeminski.githubactions.wrappergenerator.generation.GenerationKt.generateWrapper$default(Generation.kt:44)
at it.krzeminski.githubactions.wrappergenerator.GenerationEntryPointKt.generateWrappers(GenerationEntryPoint.kt:39)
at it.krzeminski.githubactions.wrappergenerator.GenerationEntryPointKt.main(GenerationEntryPoint.kt:28)
at it.krzeminski.githubactions.wrappergenerator.GenerationEntryPointKt.main(GenerationEntryPoint.kt)
When trying to run it with three / two levels accordingly.
enhancementNo, it's not supported
https://api.github.com/repos/krzema12/github-workflows-kt/actions/runs?branch=main&event=push
https://docs.github.com/en/rest/actions/workflow-runs?apiVersion=2022-11-28#list-workflow-runs-for-a-repository
operationalhttps://kotlinlang.slack.com/archives/C02UUATR7RC/p1669500030127449?thread_ts=1669498777.877479&cid=C02UUATR7RC
Ideas how to proceed:
None.
None.
None.
Full Changelog: https://github.com/krzema12/github-workflows-kt/compare/v0.32.0...v0.33.0
Source code(tar.gz)None.
None.
Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.31.0...v0.32.0
Source code(tar.gz)Full Changelog: https://github.com/krzema12/github-workflows-kt/compare/v0.30.0...v0.31.0
Source code(tar.gz)None.
Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.29.0...v0.30.0
Source code(tar.gz)None.
None.
Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.28.0...v0.29.0
Source code(tar.gz)JobBuilder or Job type. They now need a type parameter, in simple cases <*> is enoughFull Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.27.0...v0.28.0
Source code(tar.gz)None.
None.
None.
Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.26.0...v0.27.0
Source code(tar.gz)'on': -> on:Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.25.0...v0.26.0
Source code(tar.gz)Also, thanks @aSemy for contributing to the build system config!
Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.24.0...v0.25.0
Source code(tar.gz)None.
None.
Also, thanks @aSemy and @Goooler for improvements in the build system config!
Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.23.0...v0.24.0
Source code(tar.gz)BooleanCustomValue or ListCustomValue. See the docs for examplesFull Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.22.0...v0.23.0
Source code(tar.gz)Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.21.0...v0.22.0
Source code(tar.gz)expr(...) to expression package (https://github.com/krzema12/github-actions-kotlin-dsl/commit/3c0f984f9241c2d2fd47dda4baa5a247c2406d82)Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.20.0...v0.21.0
Source code(tar.gz)Kudos to @Vampire, @aSemy, @jmfayard for their contributions! :smile:
Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.19.0...v0.20.0
Source code(tar.gz)Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.18.0...v0.19.0
Kudos to @NikkyAI for cooperating on https://github.com/krzema12/github-actions-kotlin-dsl/commit/f88e648b953732561658e2350fc0f242ebf82fd4!
Source code(tar.gz)Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.17.0...v0.18.0
sourceFile. If desired, it's possible to override just the name. Kudos to @NikkyAI for cooperation on it!Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.16.0...v0.17.0
Source code(tar.gz)Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.15.0...v0.16.0
Source code(tar.gz)Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.14.0...v0.15.0
Source code(tar.gz)Thanks @jmfayard and @aSemy for your contributions!
Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.13.0...v0.14.0
Source code(tar.gz)Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.12.0...v0.13.0
Source code(tar.gz)name to id for jobsFull Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.11.0...v0.12.0
Source code(tar.gz)CustomAction for adding untyped wrapper (https://github.com/krzema12/github-actions-kotlin-dsl/commit/e050db40e33925902d45880192660a5f2b6a1dc6) (thanks @jmfayard!)New/changed wrappers:
Wrapper generator:
@Deprecated to wrappers for actions of older versions (https://github.com/krzema12/github-actions-kotlin-dsl/commit/e312b6c40b93ecf26054e8c1114008d8225cfeae) (thanks @jmfayard!)None.
Full Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.10.0...v0.11.0
Source code(tar.gz)New wrappers:
Wrapper generator:
None.
writeToFile(). Depending on your file layout, you may need to adjust your workflows, either by making use of the new git-based consistency check, or opting out of the consistency check by passing addConsistencyCheck = falseFull Changelog: https://github.com/krzema12/github-actions-kotlin-dsl/compare/v0.9.0...v0.10.0
Source code(tar.gz)@Deprecated annotations for deprecated action inputs (https://github.com/krzema12/github-actions-kotlin-dsl/commit/f9c43c16c52861fa4bb0074d4e73b9afa83bf4be) (thanks @jmfayard!)push field is now String*, [ or !CreateBranchV2 is now ActionCreateBranchV2 - the name is inferred straight from the action name (https://github.com/krzema12/github-actions-kotlin-dsl/commit/4a2f2ea5a6b8b6ff1cd4cd1a3e1cdace27a10066)CheckoutV2, FetchDepth's concrete value is now passed with Value class instead of Quantity (https://github.com/krzema12/github-actions-kotlin-dsl/commit/a8bcdf1b93ca9ccd0a1876ccc0a0e655ed41cd79)None.
None.
Source code(tar.gz)push and pull_request triggersPullRequest, Push and WorkflowDispatch are now classes, not objects. It means that using them as triggers requires syntax e.g. PullRequest(). It's done to be able to add parameters to them, e.g. filters, like mentioned in the features section. The triggers are now also in triggers package, not an inner class of Trigger (change e.g. ...Trigger.Push to ...triggers.Push in your imports)artifact parameter to name (https://github.com/krzema12/github-actions-kotlin-dsl/commit/b23f671e7f02668d4ae61fe9863a0ba05025429e, https://github.com/krzema12/github-actions-kotlin-dsl/commit/8f12c7f2d4258eb85863305094aaef75901f2ee3)kotlin-client-dsl a kotlin-based dsl project for a (Client) -> (Plugin) styled p
github-actions-cd-template-jvm A Template for a Github Actions Pipeline for building and publishing Gradle-JVM Applications It build a executable shad
Godot AdMob Android A Godot's plugin for Android of AdMob. About • Installation • Docs • Downloads About This repository is for a Godot Engine Plugin
?? pin-github-actions Using a branch name or tag name as a version for a GitHub action is dangerous as neither branches nor tags are immutable. (See G
Actions On Google Client Library This is a port of the official Node.js SDK to Kotlin. This can also be used from Java and any JVM language. Quick Fac
Actions Actions that take in customizable paramaters, an optional target, and do things. Installation Download the jar from Releases OR compile it you
MaterialDrawerKt Create navigation drawers in your Activities and Fragments without having to write any XML, in pure Kotlin code, with access to all t
Transition X Kotlin DSL for choreographing Android Transitions TransitionManager makes it easy to animate simple changes to layout without needing to
KRecyclerDsl Kotlin Dsl for Android RecyclerView Exemple Sample project recyclerView.adapter = dataClassAdapter<MyView, MyDataClass>(R.layout.my_view,
Lychee (ex. reactive-properties) Lychee is a library to rule all the data. ToC Approach to declaring data Properties Other data-binding libraries Prop
Kakao Nice and simple DSL for Espresso in Kotlin Introduction At Agoda, we have more than 1000 automated tests to ensure our application's quality and
Android Drawable Kotlin DSL DSL for constructing the drawables in Kotlin instead of in XML Examples Shape drawables <?xml version="1.0" encoding="utf-
Warehouse DSL Warehouse is a lightweight Kotlin DSL dependency injection library this library has an extremely faster learning curve and more human fr
Code generation of Kotlin DSL for AWS CDK
Examples Characters Construct Equivalent Matches x character(Char) The character x \\ character('\\') The backslash character \0n octal(OctalValue(7))
Kotlin Object Notation Lightweight kotlin MPP DSL for building JSON trees Setup Just drop the dependency in your commonMain sourceSet kotlin { sourc
Pratt Library for parsing expressions and a beautiful Kotlin DSL Just define your operators and operands with the Kotlin DSL and the parser is ready!
Kupiter is Kotlin DSL for Junit5. Current API is only for dynamic tests. Get it repositories { maven { url 'https://jitpack.io' } } dependencies
kotlin-dsl-example Sample preferences project on android. How to use val
3 Dec 10, 2022
0 Dec 5, 2021
148 Jan 8, 2023
10 Jul 21, 2022
118 Oct 3, 2022
1 Jan 9, 2022
517 Nov 19, 2022
520 Dec 16, 2022
14 Mar 31, 2019
112 Dec 9, 2022
1.1k Nov 22, 2022
178 Dec 4, 2022
18 Jul 17, 2022
5 Dec 24, 2022
1 Oct 7, 2021
43 Dec 10, 2022
9 Oct 17, 2022
14 Oct 3, 2022
1 Dec 30, 2021