Add alternative format for GitHub PR annotations

[mroy-seedbox]

First of all, thank you for the amazing Swiss army knife that is reLint! 🙏 💙

We use it to augment the linting that SQLFluff provides, since it only covers the basics (and not all of our SQL coding standards).

This feature request is basically to be able to easily post reLint results as annotation in GitHub PRs. Basically, something similar to what SQLFluff is doing: --format github-annotation-native.

Or do you think this is something that belongs outside of the reLint codebase? (kinda like container images)

If reLint doesn't provide alternative formats, then it would mean having to parse the reLint results in order to convert them into a different format. Not ideal, but doable. But a more machine-readable format would definitely help. Something like JSON might be ideal.

And a -n/--nocolor option could also be helpful, so that the output is more machine-readable. Although if raw JSON format is provided, then this option would be unnecessary. Nevermind! It looks like this already happens automatically when there is no tty! 🙌

[codingjoe]

Hi @mroy-seedbox,

Thank you for your kind words, they mean a lot!

I think you are proposing a wonderful enhancement. I always wanted to do it, but never got around to implementing a compatible output.

Would you be interested in contributing this feature yourself? It's not too difficult, you can find GitHub's documentation here:
https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions

Cheers!
Joe

[mroy-seedbox]

Absolutely! 🙌

I don't have the time for it right now, but I'll circle back to this as soon as I have more capacity!

[codingjoe]

@mroy-seedbox I found a minute to quickly address this. Thanks for bringing this to my attention. It's a much appreciated addition, and I honestly didn't know how easy this was to implement. Thanks!

[mroy-seedbox]

Just made the change to have this in our CI/CD pipeline, and it's working well!

Thank you! 🙌

[mroy-seedbox]

The next iteration on this would be to add file groups, like this.

It's a pretty simple change!

[codingjoe]

The next iteration on this would be to add file groups, like this.

It's a pretty simple change!

I thought about that, but do they do anything in the interface? It looks different in the run logs, but the line annotations on a PR stays the same, right?

[mroy-seedbox]

Yeah, I believe the change is only aesthetic.

It groups the annotations per file in the logs, like this:

But it doesn't make any different anywhere else (AFAIK).

Otherwise, they are printed individually, like this:

[codingjoe]

It's done @mroy-seedbox. It's with grouping now.

[mroy-seedbox]

Awesome, thank you so much!! 🙌 🙏 💙