Provide inline annotation on GitHub

crystal-lang / install-crystal

GitHub Action: Install Crystal programming language

https://crystal-lang.github.io/install-crystal/configurator.html

MIT License

68 stars 8 forks source link

Provide inline annotation on GitHub #5

Closed kimburgess closed 3 years ago

kimburgess commented 3 years ago

Adds problem matcher implementations for both compiler and spec output. This allows output of these to form inline annotation when viewed either against a commit, or during the PR process within the GitHub UI.

EDEBD3CD-A236-43E4-80C2-9224B9CDC843 3A7386C8-FA98-4FED-89F9-D048360DD339 D8ED36D6-9B1B-4508-89D0-D453E6CABFF5

Limitations do exist in current upstream functionality - primarily messages can only span a single line so some information is dropped, but is still available in the full logs if required.

oprypin commented 3 years ago

Have I seen these annotations (in context of Crystal) somewhere before? If so, can you show a real example with them?

kimburgess commented 3 years ago

Here's the test repo I was using for the above: https://github.com/kimburgess/problem-matcher-test/commit/08fa428eb6f207063ede1b10520d6070274378a9

kimburgess commented 3 years ago

A couple of bits of potential fragility to note:

It should pick up different spec serialisations based on what I can see in https://github.com/crystal-lang/crystal/blob/master/src/spec/expectations.cr, but this is not thoroughly tested.
Compiler errors that result from macro expansion / generate large blocks of context in the output will not be annotated. I've not been able to see a good way for capturing that from the default formatter.

oprypin commented 3 years ago

Looks great!

I think this should have an opt-out flag. Also there are lint errors

oprypin commented 3 years ago

Thanks!

oprypin commented 3 years ago

Sorry for the pointless delay. Now this is released. https://github.com/crystal-lang/install-crystal/releases/tag/v1.5.0