stack-all: CLI tool for building across Stackage major versions

[ bsd3, distribution, program ] [ Propose Tags ]

Build your Haskell project over Stackage major LTS versions.


[Skip to Readme]

Flags

Automatic Flags
NameDescriptionDefault
aeson1

aeson-1 needs unordered-containers

Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.1, 0.1.1, 0.1.2, 0.2, 0.2.1, 0.2.2, 0.3, 0.3.1, 0.4, 0.4.0.1, 0.4.1, 0.4.2, 0.5, 0.5.1, 0.5.2, 0.6, 0.6.1, 0.6.2, 0.6.3 (info)
Change log ChangeLog.md
Dependencies aeson, base (<5), cached-json-file, config-ini, directory (>=1.2.5), extra (>=1.6.15), filepath, http-query, process, simple-cmd (>=0.1.4), simple-cmd-args (>=0.1.8), text, unordered-containers [details]
License BSD-3-Clause
Copyright 2020-2023 Jens Petersen <juhpetersen@gmail.com>
Author Jens Petersen <juhpetersen@gmail.com>
Maintainer Jens Petersen <juhpetersen@gmail.com>
Category Distribution
Home page https://github.com/juhp/stack-all
Bug tracker https://github.com/juhp/stack-all/issues
Source repo head: git clone https://github.com/juhp/stack-all.git
Uploaded by JensPetersen at 2023-10-01T17:08:42Z
Distributions LTSHaskell:0.4.2, NixOS:0.4.2, Stackage:0.6.3
Executables stack-all
Downloads 1760 total (49 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
Last success reported on 2023-10-01 [all 1 reports]

Readme for stack-all-0.4.2

[back to package description]

stack-all

A CLI tool for building Haskell projects easily over Stackage major versions.

This is how I do my Haskell build CI for projects locally with stack.

Usage

stack-all by default runs stack build over Stackage Nightly and LTS major versions (current default is nightly & LTS 21, 20, 19, 18, 16, 14, 13, 12, 11) corresponding to latest major ghc minor versions, with appropriate stack --resolver options.

Note that stack only works if a stack.yaml file exists. If no stack.yaml file is found, stack-all will create one. Of course it may still fail to build, but this allows for quickly trying to build a package that does not include stack support.

Help output

$ stack-all --version
0.4.2
$ stack-all --help
Build over Stackage versions

Usage: stack-all [--version] [(-c|--create-config) | (-s|--make-lts)]
                 [-k|--keep-going] [-d|--debug] [--refresh-cache]
                 [-n|--newest MAJOR] [(-o|--oldest MAJOR) | (-a|--all-lts)]
                 [MAJORVER... [COMMAND...]]

  stack-all builds projects easily across different Stackage versions

Available options:
  -h,--help                Show this help text
  --version                Show version
  -c,--create-config       Create a project .stack-all file
  -s,--make-lts            Create a stack-ltsXX.yaml file
  -k,--keep-going          Keep going even if an LTS fails
  -d,--debug               Verbose stack build output on error
  --refresh-cache          Force refresh of stackage snapshots.json cache
  -n,--newest MAJOR        Newest LTS release to build from
  -o,--oldest MAJOR        Oldest compatible LTS release
  -a,--all-lts             Try to build back to LTS 1 even

Overriding stack.yaml

stack-all can use stack-ltsXX.yaml files to override the default stack.yaml file for particular Stackage major versions. Note that a stack-ltsXX.yaml file will also be used for older LTS major versions until another stack-ltsYY.yaml file is found. stack-nightly.yaml is also supported, but used only for nightly.

For example if you have stack-lts19.yaml and stack-lts16.yaml files in your project, then stack.yaml will be used as normal to build nightly, lts-21 and lts-20, but stack-lts19.yaml will be used for building lts-19 and lts-18, and stack-lts16.yaml will be used for lts-16, lts-14 (and older). Since stack-all overrides the exact resolver with the latest minor snapshot, the exact minor Stackage version specified in the stack*.yaml files doesn't actually matter: stack-all always uses the latest published minor releases of Stackage major versions.

stack-ltsXX.yaml files can be easily created using stack-all --make-lts ltsXX (or -s ltsXX for short).

(Other versioned stack.yaml filenames like stack-ghc-8.8.yaml are not currently supported.)

Specifying LTS versions

You can abbreviate lts-XX args to ltsXX on the commandline. lts is also accepted and resolved to the latest major LTS version.

There are --oldest and --newest options to specify the range of lts versions to build over:

You can specify the oldest major LTS to build for with eg stack-all -o lts14. Otherwise if not configured the default oldest LTS is currently lts-11.

Similarly you can specify the newest LTS version to build from with eg stack-all -n lts19. (The default is to build from nightly.)

Alternatively, one can give one or more explicit LTS major versions to build for as arguments: eg stack-all lts18 if you only wish to build that version.

Configuring the oldest and/or newest LTS to build

You can configure the oldest working LTS major version for your project by running for example stack-all -c -o lts-16 which generates a .stack-all project config file like this:

[versions]
# lts-14 too old
oldest = lts-16

(the comment line can be used to document why the older LTS doesn't work). This specifies that the oldest LTS version to build for is lts-16.

The newest LTS to build with stack-all can similarly be configured: stack-all -c -n lts20 or setting newest = lts-20.

Running other stack commands

By default stack-all just runs the stack build command over Stackage major versions.

You can also specify a stack command to run with options on the commandline: eg

$ stack-all test --no-rerun-tests

will run stack test over the LTS versions instead.

Happy stack building!

Install

The project is released on Hackage.

You can also build from git source with stack install or cabal install.

Collaboration

The project is hosted at https://github.com/juhp/stack-all under a BSD license.