haskell-actions/hlint-setup

Reusable GitHub Action to set up hlint in a workflow. Use with haskell-actions/hlint-run.

hlint-setup

GitHub Action: Set up hlint.

Downloads a binary of HLint from @ndmitchell/hlint, caches it through @actions/tool-cache, and adds it into PATH.

See also haskell-actions/hlint-run, which will run hlint and represent its output in GitHub annotations.

Inputs

• version: The HLint version to download. Currently defaults to 3.5.

  Note that on some virtual environments, some versions of hlint need extra prerequisites installed. E.g., on ubuntu-22.04, versions hlint < 3.5 need the libncurses5 library (#128).

Outputs

• hlint-dir: Resulting directory containing the hlint executable.
• hlint-bin: Location of the hlint executable.
• version: Version of the hlint tool (same as input, if provided).

Example

name: lint
on:
  pull_request:
  push:
    branches:
      - master
      - 'releases/*'

jobs:
  hlint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4

    - name: 'Set up HLint'
      uses: haskell-actions/hlint-setup@v2

    - name: 'Run HLint'
      uses: haskell-actions/hlint-run@v2
      with:
        path: src/
        fail-on: warning

hlint-setup's Issues

Tag new release?

The latest tagged release is from January. There have been a few changes since then, notably #60. Here's the diff: 0b00243...8728035

Make default version "latest"

Instead of hard coding a default version that needs to be updated sometimes (#57), I think the default version should be "latest". That way users will get the latest version of HLint without anyone needing to change anything. And if users want to pin the current latest version at time of writing, they can specify the version input just like before.

I'd be happy to open a PR adding this functionality if it's desired. You can see how I do this with my cabal-gild-setup-action here: https://github.com/tfausak/cabal-gild-setup-action/blob/5aa7281b9e1d33818ed53230eef6f73dda3f89e1/index.js#L37