Add a github reporter for ci environments

[thompson-tomo]

I am running protolint in a cicd environment and as such it would be useful if the logs being written were in github format so thag comments can be added to the source code/files.

See https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#setting-a-warning-message for an example on the format the log messages expect.

As such This would require a new reporter github.

[carstencodes]

I think you want something that is already integrated.

There's a section in the ReadMe about CI Integrations.

Or is it anything different that you wish for?

Regards

Carsten

[thompson-tomo]

Ah I see where the confusion is. When I look at the list of reporters https://github.com/yoheimuta/protolint#reporters there is no mention of the github format and instead it is only listed in https://github.com/yoheimuta/protolint#environment-specific-output.

In fact the reporters section describe them as formatters. This raises an interesting question what happens if you set the reporter to sonar and also provide the ci-gh cli option? You have now set to formatter.

I think the nicest solution would be if the CI format options were aliases for setting the reporter ie ci-gh is the same as --reporter github. This would mean that the 4 ci formats also appeared as reporters. Alternatively if you should be able to simultaneously use the sonar reporter and the ci-gh format option then this should be called out. Perhaps by adding a sentence in the reporters section mentioning you can do it & link to the other section.

[carstencodes]

The basic idea behind that to tell the reporter as a file - like sonar or sarif - apart from the CLI output like GH, glab or azdo. The technique behind this is actually the same. In theory, it should be possible to create raw json output to stdout and and ci-gh to a file.

So, would you agree, that this issue merely refers to documentation and not to functionality?

[thompson-tomo]

The functionality is there but it might not just need documentation changes but also code change to ensure edge cases are handled.

The confusion is as follows

The basic idea behind that to tell the reporter as a file - like sonar or sarif - apart from the CLI output like GH, glab or azdo.

This doesn't match the docs which mentions:

to control the appearance of the linting results.

No mention of it being file based, in fact the default is plain which is console.

And it is contradicted by

In theory, it should be possible to create raw json output to stdout

It sounds to me the easiest to follow solution would be:

• replace reporter list with a table which contains an additional column "output_file" which is set for all but plain
• add GH, glab & azdo to this table with output_file = n/a
• ensure that the new options can be set as the reporter with the old options aliases

This way if someone wants to write json to stdout they just explicitly set the output file to empty which will trigger stdout to be used.