"Custom shell" (kotlin) should allow custom file name extension (.main.kts)

[fwilhe2]

Describe the enhancement
Actions allows to define a custom shell in worflow runs.
Kotlin has support for scripting.
I've tried to make use of Kotlin for runninng a script in Actions.
The issue is that kotlin expects a file name ending in .main.kts, but the runner creates a file without extensions for "shells" that are not hardcoded in

runner/src/Runner.Worker/Handlers/ScriptHandlerHelpers.cs

Line 38 in a2e3217

internal static string GetScriptFileExtension(string scriptType)

File name construction:

runner/src/Runner.Worker/Handlers/ScriptHandler.cs

Line 233 in a2e3217

var scriptFilePath = Path.Combine(tempDirectory, $"{Guid.NewGuid()}{ScriptHandlerHelpers.GetScriptFileExtension(shellCommand)}");

I would need some way to provide a map of kotlin to .main.kts to ScriptHandlerHelpers.GetScriptFileExtension()

Code Snippet

Consider this example workflow:

name: CI
on:
  push:
  workflow_dispatch:
jobs:
  build:
    runs-on: ubuntu-20.04
    steps:
      - uses: actions/checkout@v2
      - uses: fwilhe2/setup-kotlin@main
      - run: |
            #!/usr/bin/env kotlin
            println("hello")
        shell: kotlin {0}

I would expect to be able to run the given script in kotlin (the cli compiler is installed on the runner via fwilhe2/setup-kotlin).

Additional information

Result of the given workflow script:

This is because kotlin requires the main.kts suffix to know this should be run as a script.

Compare to running the script locally with the right or the wrong filename

~$ cat foo.main.kts 
#!/usr/bin/env kotlin
println("hello")
~$ kotlin foo.main.kts 
hello
~$ mv foo.main.kts foo
~$ kotlin foo
error: could not find or load main class foo

Did I overlook something? Is this already possible? If not, I'd be glad if some option to make this would be provided, as it would make the "custom shell" feature much more interesting.

Thanks!

[fwilhe2]

So I've tried the most naive way of fixing this by adding the values to the map as shown in https://github.com/fwilhe2/runner/commit/66b90716c5ea992afcb0ed6995523a89d3f6d18d and used that version of the runner self hosed which shows that it works in principle:

I doubt this would be an acceptable solution, but I'm not sure what could be an acceptable solution. I think there would need to be another optional field something like shell_script_pattern or something.

Any comments or suggestions/ guidance on the way to a PR would be welcome.

[fwilhe2]

For reference: I've also created an issue for Kotlin https://youtrack.jetbrains.com/issue/KT-43534

[fwilhe2]

Update: Kotlin 1.4.30-RC allows to "force" running as a script, so this is a workaround:

  build:
    runs-on: ubuntu-20.04
    steps:
      - uses: actions/checkout@v2
      - uses: fwilhe2/setup-kotlin@main
        with:
          version: 1.4.30-RC
      - run: |
            #!/usr/bin/env kotlin
            java.io.File(".").listFiles().forEach {it -> println(it.getName().toString())}
        shell: kotlin -howtorun .main.kts {0}

Still, it might be more elegant if this was possible:

      - run: |
            #!/usr/bin/env kotlin
            java.io.File(".").listFiles().forEach {it -> println(it.getName().toString())}
        shell: kotlin {0}
        scriptFileExtension: .main.kts

[LouisCAD]

Related to actions/runner-images#3687

[ruvceskistefan]

Hi @fwilhe2,
I'm sorry, I just saw that you wanted to create PR. I somehow missed this part of the text below the picture:

I doubt this would be an acceptable solution, but I'm not sure what could be an acceptable solution. I think there would need to be another optional field something like shell_script_pattern or something.

Any comments or suggestions/ guidance on the way to a PR would be welcome.

Thanks for the contribution and sorry once again.

[fwilhe2]

Thanks for the contribution and sorry once again.

No worries, I was not working on this. Looking forward to have this available 💯