Message format for GitHub Actions

[ybiquitous]

Hi, thank you so much for creating this nice tool! 😄

When I tried running actionlint on GitHub Actions, It took some time to set up. Here is my setup code:

https://gist.github.com/ybiquitous/c72834b30882d3c1f9c105683d4c1137

I use Problem Matcher in the setup code, but I doubt it difficult for many users to use Problem Matcher.

If actionlint could output messages with the ::warning or ::error format of Actions, it might be easier to set up. (But, for the purpose, severities may be needed...)

For example:

$ actionlint -format github
::error file=.github/workflows/test.yml,line=10,col=15::Something went wrong

What do you think about this idea?

[rhysd]

How about using reviewdog? It has support for actionlint. Perhaps proposing actionlint support to super-linter might be another option.

[ybiquitous]

Yes, reviewdog or super-linter is good another option!

But, I think it is useful to also provide a straightforward way when getting starting with actionlint, because users would not need to learn more about other integrations like reviewdog.

[rhysd]

I understood. I'm considering if we can make this feature a bit more generic.

It might be better to provide functionality to specify the output format by Go template notation so that users can specify output format freely. And we would be able to provide an example configuration for GitHub Actions workflow using the template.

[ybiquitous]

It might be better to provide functionality to specify the output format by Go template notation

It's like the --format option of the docker command. It sounds like a nice idea to me! 👍🏼

[rhysd]

Sounds nice. I'll check the docker's option before designing this feature.

[ybiquitous]

@rhysd Great work! Thank you so much! 😊 👏🏼

[rhysd]

This feature was released at v1.6.0.