Automated Local Cabal Package Testing and Uploading

Latest on Hackage:

This package is not currently in any snapshots. If you're interested in using it, we recommend adding it to Stackage Nightly. Doing so will make builds more reliable, and allow to host generated Haddocks.

BSD-3-Clause licensed by Lennart Spitzner
Maintained by Lennart Spitzner


Build Status Hackage


iridium is a fancy wrapper around cabal upload. It aims to automate several typical steps when releasing a new package version to hackage.

Iridium does all testing locally, in contrast to e.g. github’s travis. This makes it easier to keep your published history free of commits that fail any tests (without squashing or separate branches).

Steps currently include:

  • Compilation and running tests using multiple compiler versions. (the different compilers must already be installed.)

  • Checking that the changelog mentions the latest version.

  • Checking that the upper bounds of dependencies are up-to-date by making use of stackage snapshots.

  • Uploading of both the package itself and the documentation.

The output on errors is certainly not optimal; for example the stackage upper bound checking will print a typical, hard-to-consume cabal error message. iridium’s focus is on notifying if something is wrong.


Install iridium, run iridium in the directory containing the cabal package. It won’t do anything without confirmation.

$ iridium
Checking compilation with different compiler versions
  Checking with compiler ghc-7.8.4:                                   clear.
Checking upper bounds using stackage:                                 clear.
Checking documentation:                                               clear.
Checking basic compilation:                                           clear.
Checking that all dependencies have a lower bound:                    clear.
Checking that all dependencies have an upper bound:                   clear.
Checking package validity:                                            clear.
Testing the source distribution package:                              clear.
Testing if the changelog mentions the latest version:                 clear.
Comparing local version to hackage version:                           clear.
  Testing for uncommitted changes:                                    clear.
  Package:                iridium
  Warning count:          0
  Error   count:          0
  Not -Wall clean:        []
    Branch:               master
  Actions:                Tag the current commit with ""
                          Push current branch and tag to upstream repo
                          Upload package
                          Upload documentation
> Continue [y]es [n]o? > y
Performing upload..
Building source dist for iridium-
Preprocessing library iridium-
Preprocessing executable 'iridium' for iridium-
Source tarball created: dist/iridium-
Hackage password:
Uploading dist/iridium-
Upload successful.
Performing doc upload..
[.. some haddock spam ..]
Documentation tarball created: dist/iridium-
Hackage password:
Uploading documentation dist/iridium-
Documentation upload successful.


An iridium.yaml file will be created on first invocation.


Test Description
hlint forM_ hs-source-dirs $ \dir -> (\dir -> call "hlint " ++ dir)
testsuites run cabal test when compiling.
upper-bounds-stackage Check that upper bounds are up-to-date by using a stackage cabal.config. This is not the best way, because not all packages are on stackage, but it is better than nothing.
lower-bounds-exist Check that all dependencies have a lower bound.
upper-bounds-exist Check that all dependencies have an upper bound. (You do want to conform with the PVP, right?)
documentation Check that haddocks can be created without problems (calling cabal haddock).
changelog Check if the changelog mentions (contains) the latest version.
package-sdist Check that all necessary stuff is contained in the source distribution by installing the packaged package.
compiler-versions Compile and run tests for several compiler versions (other than the default compiler on $PATH).


Revision history for iridium – 2018-10-02

  • Add support for -Wcompat
  • Reduce dependency footprint by using json endpoint of hackage interface – 2017-08-01

  • Adapt for cabal-2.0 - Note that this is a breaking change; uploading with cabal-1.* will not work with this version. – 2016-09-28

  • Only internal changes (support ghc-8, fix support for ghc-7.8; adapt/switch to turtle-1.3.0) – 2016-09-28

  • Slight improvements around the handling of testing against multiple compiler versions – 2016-05-21

  • Fix git branch parsing issue – 2016-04-22

  • Include cabal update invocation by default
  • Add warning for missing remote version – 2016-03-11

  • Improve stackage upper-bound check error output – 2016-03-11

  • Fix iridium package pvp compliance (lower bounds)
  • First hackage release – 2016-03-11

  • Add package-sdist check

  • Prepare non-static default config – 2016-02-22

  • Fix various bugs

  • Make various changes to the default iridium.yaml

  • Fix/Expand basic git functionality; it includes:

    • Displaying current branch
    • Tagging the current commit
    • Pushing tag and branch to remote – 2016-02-18

  • Start integrating some git-specific functionality – 2016-02-17

  • First release, experimental.
comments powered byDisqus