Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tfausak/cabal-gild-setup-action
:crown: Format Haskell package descriptions.
https://github.com/tfausak/cabal-gild-setup-action
action cabal formatter haskell
Last synced: 25 days ago
JSON representation
:crown: Format Haskell package descriptions.
- Host: GitHub
- URL: https://github.com/tfausak/cabal-gild-setup-action
- Owner: tfausak
- License: mit
- Created: 2024-02-16T17:48:22.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-08-26T15:10:09.000Z (2 months ago)
- Last Synced: 2024-08-26T17:53:13.755Z (2 months ago)
- Topics: action, cabal, formatter, haskell
- Language: JavaScript
- Homepage: https://github.com/marketplace/actions/setup-gild
- Size: 563 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# cabal-gild-setup-action
This action installs the `cabal-gild` executable from the [Gild][] project,
which can be used to format Haskell package descriptions (`*.cabal` files).
[Gild]: https://github.com/tfausak/cabal-gild
## Usage
Basic usage:
``` yaml
jobs:
gild:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: tfausak/cabal-gild-setup-action@v2
- run: cabal-gild --input my-package.cabal --mode check
```
Specifying a version:
``` yaml
jobs:
gild:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: tfausak/cabal-gild-setup-action@v2
with:
version: 1.1.0.0
- run: cabal-gild --input my-package.cabal --mode check
```
## Inputs
- `token`: Optional, defaults to `${{ github.token }}`. The token to use when
communicating with GitHub's API to get the latest release of Gild. If this is
unset, the API request will be unauthenticated and may be rate limited.
- `version`: Optional, defaults to `latest`. The version of Gild to use. Find
versions on [the releases page][]. `v1` of this action supports `< 1.0.2.1`.
`v2` of this action supports `>= 1.0.2.1`.
[the releases page]: https://github.com/tfausak/cabal-gild/releases