Skip to content

tfausak/cabal-gild-setup-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

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).

Usage

Basic usage:

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:

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.