Add hlint gh-action ignoring one suggestion. #85
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| name: hlint | ||
|
|
||
| on: | ||
| pull_request: | ||
| push: | ||
|
|
||
| jobs: | ||
| build: | ||
| name: hlint | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v3 | ||
|
|
||
| - name: Set up HLint | ||
| uses: haskell/actions/hlint-setup@v2 | ||
| with: | ||
| version: "3.3.6" | ||
|
|
||
| - name: Run Hlint | ||
| uses: haskell/actions/hlint-run@v2 | ||
| with: | ||
| path: '["src/", "test/"]' | ||
| fail-on: suggestion | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This step could be done before the
BuildstepThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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/hlintjob was last triggered when I edited the workflow whereas thehlint-standalone/hlint-standalonejob was triggered when I made any change (hlint is lightweight so this doesn't cost much).