https://github.com/freckle/weeder-action

Run Weeder to uncover unused Haskell functions
https://github.com/freckle/weeder-action

actions haskell

Last synced: 7 days ago
JSON representation

Run Weeder to uncover unused Haskell functions

• Host: GitHub
• URL: https://github.com/freckle/weeder-action
• Owner: freckle
• License: mit
• Created: 2021-11-16T14:18:05.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-06T17:39:45.000Z (9 months ago)
• Last Synced: 2024-04-06T18:25:59.754Z (9 months ago)
• Topics: actions, haskell
• Language: Haskell
• Homepage:
• Size: 125 KB
• Stars: 6
• Watchers: 13
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Weeder Action

GitHub Action to run Weeder to find any unused functions in a Haskell project

and annotate the Build with their locations.

![Example in Diff](./example-in-diff.png)

## Prerequisites

See the [Weeder README][weeder] for project requirements.

[weeder]: https://github.com/ocharles/weeder#readme

You will need to run this step in the same Job as you compile your project, or

make the `.hie` files available some other way.

## Usage

```yaml

steps:

  - uses: actions/checkout@v3

  - uses: freckle/stack-cache-action@v2

  - id: stack

    uses: freckle/stack-action@v3

  - uses: freckle/weeder-action@v2

    with:

      ghc-version: ${{ steps.stack.outputs.compiler-version }}

```

## Inputs

- **ghc-version**: You must specify the `ghc-version` your project is compiled

  with (to ensure `.hie` compatibility).

  This Action maintains and installs pre-compiled `weeder` binaries for Mac and

  Linux across all GHC versions that `weeder` compiles on (8.8.1 to 9.2.5 at

  time of this writing). Please file an Issue if you're using a GHC that's not

  supported, but for which a released version of `weeder` does exist.

- **weeder-arguments**: Arguments to pass when invoking `weeder`

  Default is `--require-hs-files`, which ensures that cached builds that have

  since removed files (but still have their `.hie` files present) don't generate

  false positives.

- **working-directory**: Change to this directory before running.

  This can be necessary if in a mono-repository.

- **fail**: Fail if we find unused functions?

  Default is true. This is useful if you want to not fail the step, but do

  something else with the weeder output yourself.

## Outputs

This Action sets an output named `log` to the path containing the output of

running `weeder`. This can be useful if you use `fail: false` and wish to do

something on that output yourself afterwards.

---

[LICENSE](./LICENSE)