[Core feature request] run multiline string command

[benkeil]

What feature do you need?

If the run command, contains \n it should be also a multiline string in the resulting yaml for better readability.

Do you have an example usage?

run(
    name = "upload package to s3",
    workingDirectory = workingDir,
    command = """
        VERSION=$(cat package.json | jq -r '.version')
        BUCKET_NAME=$(aws ssm get-parameter --name $bucketNameSsmParameter | jq -r '.Parameter.Value')
        aws s3 cp dist s3://$bucketName/apps/accountinfo/$version/ --recursive 
        echo $version > VERSION
        aws s3 cp VERSION s3://$bucketName/apps/accountinfo/
    """.trimIndent(),
)

Is there a workaround for not having this feature? If yes, please describe it.

no impact, just not as readable as multiline

[krzema12]

Yes, I agree that ideally the new lines should be present in the YAML.

Here's a related issue: #616 where we set max line length for snakeyaml (our YAML emitting library) to max, but it was rather a mitigation/workaround than a proper solution:

github-workflows-kt/library/src/main/kotlin/it/krzeminski/githubactions/yaml/ObjectToYaml.kt

Lines 23 to 25 in 276c94f

	// Otherwise line breaks appear in places that create an incorrect YAML, e.g. in the middle of GitHub
	// expressions.
	.setWidth(Int.MAX_VALUE)

It was likely caused by a bug in snakeyaml. We track reporting this and other issues to the maintainer in #634. Once this is fixed, we can consider going back to having proper new lines in the emitted YAML.