iridium.yaml

---
setup:
  buildtool: cabal # cabal | stack

  # This currently only checks that uploads happen to that remote,
  # it does not change the remote if a different one is configured.
  # (because that would require modifying `.cabal/config`,)
  # remote-server: http://127.0.0.1:8080
  remote-server: http://hackage.haskell.org

process:
  dry-run: False # only run all checks/tests, omit any side-effects/uploading

  display-help: True

  # build docs locally and upload them instead of trusting the
  # docs builder which gets broken every two months.
  # implies the documentation check.
  upload-docs: True
  
  print-summary: True

  # confirm-always     always ask for confirmation.
  # confirm-on-warning don't ask for confirmation if everything is clear.
  # confirm-on-error   only ask for confirmation if there are errors.
  confirmation: confirm-always

  run-cabal-update: True

checks:
  hlint:
    enabled: False
  testsuites:
    enabled: False
  compiler-warnings:
    enabled: True
    enable-compat: True
    # whitelist: [only, these, tests]
    # blacklist: [omit, these, tests]
  package-sdist:
    enabled: True
  upper-bounds-stackage:
    # for existing upper bounds
    enabled: True
    use-nightly: False
    # blacklist: [omit, check, for, these, packages]
  lower-bounds-exist:
    enabled: True
  upper-bounds-exist:
    enabled: True
  changelog:
    enabled: True
    location: ChangeLog.md
  compiler-versions:
    enabled: True
    compilers:
      - compiler: ghc
        version: 7.10.3
      - compiler: ghc
        version: 8.0.2
      - compiler: ghc
        version: 8.2.2
  documentation:
    enabled: True

repository:
  type: git # none | git
  git:
    display-current-branch: True
    release-tag: # NOT YET SUPPORTED !
      enabled: True
      content: "$VERSION"
    push-remote: # NOT YET SUPPORTED !
      # push the current branch (and the tag, if configured) to
      # a remote repo.
      enabled: True
      # the "remote" configured in git to push the release/tag to.
      remote-name: "lspitzner"
...