Add hlint gh-action ignoring one suggestion. #85
Conversation
.hlint.yaml
Outdated
| @@ -0,0 +1,2 @@ | |||
| # Warnings currently triggered by your code | |||
| - ignore: {name: "Unused LANGUAGE pragma"} # 1 hint | |||
There was a problem hiding this comment.
It would be better to just remove the unused pragma rather than ignore it 🙂
There was a problem hiding this comment.
I'd intended to do this in two steps. Add the gh-action that passes then on one or more separate PRs fix lint suggestions while keeping the gh-action in the green.
There was a problem hiding this comment.
I would like to not have ignored suggestions even in the meantime, so I prefer to have everything done in one 🙂
There was a problem hiding this comment.
My own preference is for having the ignores in there as a TODO list but I did as you asked.
.github/workflows/hlint.yml
Outdated
| uses: haskell/actions/hlint-run@v2 | ||
| with: | ||
| path: '["src/", "test/"]' | ||
| fail-on: suggestion |
There was a problem hiding this comment.
I think it could be added ass another job to the existing workflow we have for the project 👌🏼
There was a problem hiding this comment.
One reason for having a separate action is that hlint runs very quickly (doesn't require a build).
There was a problem hiding this comment.
This step could be done before the Build step
There was a problem hiding this comment.
I did this but in testing found it gave less feedback. I had to rely on trusting that running hlint locally would work the same as when run in the workflow. This can be seen by comparing hlint and hlint-standalone workflow runs. The CI/hlint job was last triggered when I edited the workflow whereas the hlint-standalone/hlint-standalone job was triggered when I made any change (hlint is lightweight so this doesn't cost much).
Automates a check for one of the checklist items for contributions, that
hlint .has no hints.