srid/haskell-flake

Add `cabal check` to `checks`

Open

#50 opened on Dec 1, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Nix (26 forks)github user discovery
enhancementgood first issue

Repository metrics

Stars
 (231 stars)
PR merge metrics
 (Avg merge 9h 49m) (1 merged PR in 30d)

Description

In arion I had a separate build with

                  checked = super.haskell.lib.overrideCabal pkg (o: {
                    postConfigure = ''${o.postConfigure or ""}
                      if ! ${hsuper.cabal-install}/bin/cabal check;
                      then
                        echo 1>&2 ERROR: cabal file is invalid. Above warnings were errors.
                        exit 1
                      fi
                    '';
                  });

I think we could touch the outputs and exit 0 to speed this up. Doing it in runCommand would be fragile. This should probably call Setup.hs instead of cabal-install.

Running it as part of the main build isn't ideal because the check may be more strict than necessary. I think it should only run in CI.

Contributor guide

Research direction
Inspect the existing checks in the flake module and implement a new check using Setup.hs or cabal install.
Tech stack
haskell
Domain
build systemdevops
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
NixHaskellcabal
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60