The iridium package

[Tags:bsd3, library, program]

This executable aims to automate several typical steps when uploading a new package version to hackage.

Steps currently include:

The program is configurable using a per-project .yaml file.

See the README.


[Skip to Readme]

Properties

Versions 0.1.5.1, 0.1.5.2, 0.1.5.3, 0.1.5.4, 0.1.5.5, 0.1.5.6
Change log ChangeLog.md
Dependencies ansi-terminal (>=0.6.2.3 && <0.7), base (>=4.7 && <4.10), bytestring (>=0.10.4.0 && <0.11), Cabal (>=1.22.5.0 && <1.25), containers (>=0.5.5.1 && <0.6), extra (>=1.4.3 && <1.5), foldl (>=1.1.5 && <1.3), http-conduit (>=2.1.8 && <2.2), iridium, lifted-base (>=0.2.3.6 && <0.3), monad-control (>=1.0.0.5 && <1.1), multistate (>=0.7.0.0 && <0.8), process (>=1.2.3.0 && <1.5), split (>=0.2.3 && <0.3), system-filepath (>=0.4.13.4 && <0.5), tagged (>=0.8.3 && <0.9), text (>=1.2.2.0 && <1.3), transformers (>=0.3.0.0 && <0.6), transformers-base (>=0.4.4 && <0.5), turtle (>=1.3.0 && <1.4), unordered-containers (>=0.2.5.1 && <0.3), vector (>=0.11.0.0 && <0.12), xmlhtml (>=0.2.3.4 && <0.3), yaml (>=0.8.16 && <0.9) [details]
License BSD3
Copyright Copyright (C) 2016 Lennart Spitzner
Author Lennart Spitzner
Maintainer lsp@informatik.uni-kiel.de
Category Development
Home page https://github.com/lspitzner/iridium
Bug tracker https://github.com/lspitzner/iridium/issues
Source repository head: git clone https://github.com/lspitzner/iridium.git
Uploaded Tue Dec 20 15:47:10 UTC 2016 by lspitzner
Distributions NixOS:0.1.5.6
Downloads 204 total (9 in the last 30 days)
Votes
0 []
Status Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for iridium

Readme for iridium-0.1.5.6

iridium

Build Status Hackage

Introduction

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.

Usage

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.
[git]
  Testing for uncommitted changes:                                    clear.
Summary:
  Package:                iridium
  Version:                0.1.5.1
  Warning count:          0
  Error   count:          0
  Not -Wall clean:        []
  [git]
    Branch:               master
  Actions:                Tag the current commit with "0.1.5.1"
                          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-0.1.2.0...
Preprocessing library iridium-0.1.2.0...
Preprocessing executable 'iridium' for iridium-0.1.2.0...
Source tarball created: dist/iridium-0.1.2.0.tar.gz
Hackage password:
Uploading dist/iridium-0.1.2.0.tar.gz...
Ok
Upload successful.
Performing doc upload..
[.. some haddock spam ..]
Documentation tarball created: dist/iridium-0.1.2.0-docs.tar.gz
Hackage password:
Uploading documentation dist/iridium-0.1.2.0-docs.tar.gz...
Ok
Documentation upload successful.
$

Configuration

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

Tests

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