Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Adds a github formatter #463

Merged

Conversation

isaacsanders
Copy link
Contributor

@isaacsanders isaacsanders commented Jul 12, 2022

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
Copy link
Owner

jeremyjh commented Jul 12, 2022

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
Copy link
Contributor Author

isaacsanders commented Jul 13, 2022

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
Copy link
Owner

jeremyjh commented Jul 13, 2022

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

@isaacsanders
Copy link
Contributor Author

isaacsanders commented Jul 13, 2022

Added in. Thanks for the review and promptness!

@isaacsanders isaacsanders changed the title refactor: Extracts formatter modules feat: Adds a github formatter Jul 13, 2022
@jeremyjh
Copy link
Owner

jeremyjh commented Jul 13, 2022

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 isaacsanders requested a review from jeremyjh Jul 14, 2022
@isaacsanders
Copy link
Contributor Author

isaacsanders commented Jul 14, 2022

I've added the docs

Copy link
Owner

@jeremyjh jeremyjh left a comment

Looks great, thank you!

@jeremyjh jeremyjh enabled auto-merge Jul 14, 2022
@jeremyjh jeremyjh disabled auto-merge Jul 14, 2022
@jeremyjh
Copy link
Owner

jeremyjh commented Jul 14, 2022

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

@jeremyjh jeremyjh merged commit d38e42f into jeremyjh:master Jul 20, 2022
9 checks passed
@isaacsanders isaacsanders deleted the refactor/extract-formatter-modules branch Jul 20, 2022
@jeremyjh
Copy link
Owner

jeremyjh commented Jul 20, 2022

I've published to hex as 1.2.

@isaacsanders
Copy link
Contributor Author

isaacsanders commented Jul 20, 2022

Thanks Jeremy! For this and for being a maintainer!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants