search

jeremyjh / dialyxir

Mix tasks to simplify use of Dialyzer in Elixir projects.
Apache License 2.0
1.69k stars 141 forks source link

feat: Adds a github formatter #463

Closed isaacsanders closed 2 years ago

isaacsanders commented 2 years ago

I would am working to create a github actions formatter for this library, and the first step I wanted to take is to extract the other formats into modules.

jeremyjh commented 2 years ago

Hi, I'm not opposed to the refactoring but can you explain a bit more about what you are trying to accomplish? Is it returning the results in a structure understood by github actions so they appear better in PRs? And then you'll do another PR to implement an action formatter?

isaacsanders commented 2 years ago

https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-error-message

I have the action formatter written already, but I figured doing changes in smaller chunks was a better approach.

The link above outlines the format. It allows for inline annotations of the files from the github check run, i believe.

jeremyjh commented 2 years ago

@isaacsanders Makes sense - I'd say though let's just include it in this PR so that it is a complete feature.

isaacsanders commented 2 years ago

Added in. Thanks for the review and promptness!

jeremyjh commented 2 years ago

This all looks pretty good, could I ask you though to also update the mix help & readme docs to document the new "github" option?

isaacsanders commented 2 years ago

I've added the docs

jeremyjh commented 2 years ago

@isaacsanders I just realized I had to release it to run CI, there are a couple of compile warnings can you please check?

jeremyjh commented 2 years ago

I've published to hex as 1.2.

isaacsanders commented 2 years ago

Thanks Jeremy! For this and for being a maintainer!